Add version to @deprecated tags

This commit is contained in:
Morris Jobke 2015-04-19 01:04:59 +02:00
parent cdf82909b8
commit c056c52010
14 changed files with 89 additions and 87 deletions

View File

@ -46,7 +46,7 @@ class App {
* @param array $data with all information * @param array $data with all information
* @return boolean * @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. * It'll remain in our public API for compatibility reasons.
* *
*/ */
@ -72,7 +72,7 @@ class App {
* @param array $data containing the data * @param array $data containing the data
* @return boolean * @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 * register a closure, this helps to speed up all requests against ownCloud
* @since 4.0.0 * @since 4.0.0
*/ */
@ -90,7 +90,7 @@ class App {
* property from all other entries. The templates can use this for * property from all other entries. The templates can use this for
* highlighting the current position of the user. * 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 * @since 4.0.0
*/ */
public static function setActiveNavigationEntry( $id ) { public static function setActiveNavigationEntry( $id ) {

View File

@ -154,7 +154,7 @@ abstract class Controller {
/** /**
* Lets you access post and get parameters by the index * 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 * @param string $key the key which you want to access in the URL Parameter
* placeholder, $_POST or $_GET array. * placeholder, $_POST or $_GET array.
* The priority how they're returned is the following: * The priority how they're returned is the following:
@ -173,7 +173,7 @@ abstract class Controller {
/** /**
* Returns all params that were received, be it from the request * Returns all params that were received, be it from the request
* (as GET or POST) or through the URL by the route * (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 * @return array the array with all parameters
* @since 6.0.0 * @since 6.0.0
*/ */
@ -184,7 +184,7 @@ abstract class Controller {
/** /**
* Returns the method of the request * 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) * @return string the method of the request (POST, GET, etc)
* @since 6.0.0 * @since 6.0.0
*/ */
@ -195,7 +195,7 @@ abstract class Controller {
/** /**
* Shortcut for accessing an uploaded file through the $_FILES array * 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 * @param string $key the key that will be taken from the $_FILES array
* @return array the file in the $_FILES element * @return array the file in the $_FILES element
* @since 6.0.0 * @since 6.0.0
@ -207,7 +207,7 @@ abstract class Controller {
/** /**
* Shortcut for getting env variables * 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 * @param string $key the key that will be taken from the $_ENV array
* @return array the value in the $_ENV element * @return array the value in the $_ENV element
* @since 6.0.0 * @since 6.0.0
@ -219,7 +219,7 @@ abstract class Controller {
/** /**
* Shortcut for getting cookie variables * 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 * @param string $key the key that will be taken from the $_COOKIE array
* @return array the value in the $_COOKIE element * @return array the value in the $_COOKIE element
* @since 6.0.0 * @since 6.0.0
@ -231,7 +231,7 @@ abstract class Controller {
/** /**
* Shortcut for rendering a template * 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 string $templateName the name of the template
* @param array $params the template parameters in key => value structure * @param array $params the template parameters in key => value structure
* @param string $renderAs user renders a full page, blank only your template * @param string $renderAs user renders a full page, blank only your template

View File

@ -33,7 +33,7 @@ namespace OCP\AppFramework;
/** /**
* A few very basic and frequently used API functions are combined in here * A few very basic and frequently used API functions are combined in here
* @deprecated * @deprecated 8.0.0
*/ */
interface IApi { interface IApi {
@ -41,14 +41,14 @@ interface IApi {
/** /**
* Gets the userid of the current user * Gets the userid of the current user
* @return string the user id 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(); function getUserId();
/** /**
* Adds a new javascript file * 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 $scriptName the name of the javascript in js/ without the suffix
* @param string $appName the name of the app, defaults to the current one * @param string $appName the name of the app, defaults to the current one
* @return void * @return void
@ -58,7 +58,7 @@ interface IApi {
/** /**
* Adds a new css file * 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 $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 * @param string $appName the name of the app, defaults to the current one
* @return void * @return void
@ -67,7 +67,7 @@ interface IApi {
/** /**
* @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 * shorthand for addScript for files in the 3rdparty directory
* @param string $name the name of the file without the suffix * @param string $name the name of the file without the suffix
* @return void * @return void
@ -76,7 +76,7 @@ interface IApi {
/** /**
* @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 * shorthand for addStyle for files in the 3rdparty directory
* @param string $name the name of the file without the suffix * @param string $name the name of the file without the suffix
* @return void * @return void
@ -86,7 +86,7 @@ interface IApi {
/** /**
* Checks if an app is enabled * 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) * callbacks or interfaces (check the contacts and calendar managers)
* Checks if an app is enabled * Checks if an app is enabled
* also use \OC::$server->getAppManager()->isEnabledForUser($appName) * also use \OC::$server->getAppManager()->isEnabledForUser($appName)

View File

@ -44,7 +44,7 @@ interface IAppContainer extends IContainer {
function getAppName(); function getAppName();
/** /**
* @deprecated implements only deprecated methods * @deprecated 8.0.0 implements only deprecated methods
* @return IApi * @return IApi
* @since 6.0.0 * @since 6.0.0
*/ */
@ -64,23 +64,21 @@ interface IAppContainer extends IContainer {
function registerMiddleWare($middleWare); function registerMiddleWare($middleWare);
/** /**
* @deprecated use IUserSession->isLoggedIn() * @deprecated 8.0.0 use IUserSession->isLoggedIn()
* @return boolean * @return boolean
* @since 6.0.0 * @since 6.0.0
*/ */
function isLoggedIn(); function isLoggedIn();
/** /**
* @deprecated use IGroupManager->isAdmin($userId) * @deprecated 8.0.0 use IGroupManager->isAdmin($userId)
* @return boolean * @return boolean
* @deprecated use the groupmanager instead to find out if the user is in
* the admin group
* @since 6.0.0 * @since 6.0.0
*/ */
function isAdminUser(); function isAdminUser();
/** /**
* @deprecated use the ILogger instead * @deprecated 8.0.0 use the ILogger instead
* @param string $message * @param string $message
* @param string $level * @param string $level
* @return mixed * @return mixed

View File

@ -88,7 +88,7 @@ class BackgroundJob {
} }
/** /**
* @deprecated * @deprecated 6.0.0
* creates a regular task * creates a regular task
* @param string $klass class name * @param string $klass class name
* @param string $method method name * @param string $method method name
@ -103,7 +103,7 @@ class BackgroundJob {
} }
/** /**
* @deprecated * @deprecated 6.0.0
* gets all regular tasks * gets all regular tasks
* @return array * @return array
* *
@ -124,7 +124,7 @@ class BackgroundJob {
} }
/** /**
* @deprecated * @deprecated 6.0.0
* Gets one queued task * Gets one queued task
* @param int $id ID of the task * @param int $id ID of the task
* @return BackgroundJob\IJob|null * @return BackgroundJob\IJob|null
@ -136,7 +136,7 @@ class BackgroundJob {
} }
/** /**
* @deprecated * @deprecated 6.0.0
* Gets all queued tasks * Gets all queued tasks
* @return array an array of associative arrays * @return array an array of associative arrays
* @since 4.5.0 * @since 4.5.0
@ -156,7 +156,7 @@ class BackgroundJob {
} }
/** /**
* @deprecated * @deprecated 6.0.0
* Gets all queued tasks of a specific app * Gets all queued tasks of a specific app
* @param string $app app name * @param string $app app name
* @return array an array of associative arrays * @return array an array of associative arrays
@ -179,7 +179,7 @@ class BackgroundJob {
} }
/** /**
* @deprecated * @deprecated 6.0.0
* queues a task * queues a task
* @param string $app app name * @param string $app app name
* @param string $class class name * @param string $class class name
@ -194,7 +194,7 @@ class BackgroundJob {
} }
/** /**
* @deprecated * @deprecated 6.0.0
* deletes a queued task * deletes a queued task
* @param int $id id of task * @param int $id id of task
* @return boolean|null * @return boolean|null

View File

@ -43,7 +43,7 @@ namespace OCP;
/** /**
* This class provides functions to read and write configuration data. * This class provides functions to read and write configuration data.
* configuration can be on a system, application or user level * 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 { class Config {
/** /**
@ -51,7 +51,7 @@ class Config {
* @param string $key key * @param string $key key
* @param mixed $default = null default value * @param mixed $default = null default value
* @return mixed the value or $default * @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, * This function gets the value from config.php. If it does not exist,
* $default will be returned. * $default will be returned.
@ -65,7 +65,7 @@ class Config {
* @param string $key key * @param string $key key
* @param mixed $value value * @param mixed $value value
* @return bool * @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 * This function sets the value and writes the config.php. If the file can
* not be written, false will be returned. * not be written, false will be returned.
@ -82,7 +82,7 @@ class Config {
/** /**
* Deletes a value from config.php * Deletes a value from config.php
* @param string $key key * @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. * This function deletes the value from config.php.
*/ */
@ -96,7 +96,7 @@ class Config {
* @param string $key key * @param string $key key
* @param string $default = null, default value if the key does not exist * @param string $default = null, default value if the key does not exist
* @return string the value or $default * @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 * This function gets a value from the appconfig table. If the key does
* not exist the default value will be returned * not exist the default value will be returned
@ -111,7 +111,7 @@ class Config {
* @param string $key key * @param string $key key
* @param string $value value * @param string $value value
* @return boolean true/false * @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. * Sets a value. If the key did not exist before it will be created.
*/ */
@ -131,7 +131,7 @@ class Config {
* @param string $key key * @param string $key key
* @param string $default = null, default value if the key does not exist * @param string $default = null, default value if the key does not exist
* @return string the value or $default * @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 * This function gets a value from the preferences table. If the key does
* not exist the default value will be returned * not exist the default value will be returned
@ -147,7 +147,7 @@ class Config {
* @param string $key key * @param string $key key
* @param string $value value * @param string $value value
* @return bool * @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 * Adds a value to the preferences. If the key did not exist before, it
* will be added automagically. * will be added automagically.

View File

@ -28,25 +28,25 @@
namespace OCP; namespace OCP;
/** @deprecated Use \OCP\Constants::PERMISSION_CREATE instead */ /** @deprecated 8.0.0 Use \OCP\Constants::PERMISSION_CREATE instead */
const PERMISSION_CREATE = 4; 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; 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; 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; 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; 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; 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"; const FILENAME_INVALID_CHARS = "\\/<>:\"|?*\n";
/** /**
@ -58,6 +58,7 @@ const FILENAME_INVALID_CHARS = "\\/<>:\"|?*\n";
class Constants { class Constants {
/** /**
* CRUDS permissions. * CRUDS permissions.
* @since 8.0.0
*/ */
const PERMISSION_CREATE = 4; const PERMISSION_CREATE = 4;
const PERMISSION_READ = 1; const PERMISSION_READ = 1;
@ -66,5 +67,8 @@ class Constants {
const PERMISSION_SHARE = 16; const PERMISSION_SHARE = 16;
const PERMISSION_ALL = 31; const PERMISSION_ALL = 31;
/**
* @since 8.0.0
*/
const FILENAME_INVALID_CHARS = "\\/<>:\"|?*\n"; const FILENAME_INVALID_CHARS = "\\/<>:\"|?*\n";
} }

View File

@ -45,7 +45,7 @@ interface IAppConfig {
* @param string $key key * @param string $key key
* @param string $default = null, default value if the key does not exist * @param string $default = null, default value if the key does not exist
* @return string the value or $default * @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 * This function gets a value from the appconfig table. If the key does
* not exist the default value will be returned * not exist the default value will be returned
@ -58,7 +58,7 @@ interface IAppConfig {
* @param string $app app * @param string $app app
* @param string $key key * @param string $key key
* @return bool * @return bool
* @deprecated use method deleteAppValue of \OCP\IConfig * @deprecated 8.0.0 use method deleteAppValue of \OCP\IConfig
* @since 7.0.0 * @since 7.0.0
*/ */
public function deleteKey($app, $key); public function deleteKey($app, $key);
@ -67,7 +67,7 @@ interface IAppConfig {
* Get the available keys for an app * Get the available keys for an app
* @param string $app the app we are looking for * @param string $app the app we are looking for
* @return array an array of key names * @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 * This function gets all keys of an app. Please note that the values are
* not returned. * not returned.
@ -90,7 +90,7 @@ interface IAppConfig {
* @param string $app app * @param string $app app
* @param string $key key * @param string $key key
* @param string $value value * @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. * Sets a value. If the key did not exist before it will be created.
* @return void * @return void
@ -112,7 +112,7 @@ interface IAppConfig {
* Remove app from appconfig * Remove app from appconfig
* @param string $app app * @param string $app app
* @return bool * @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. * Removes all keys in appconfig belonging to the app.
* @since 7.0.0 * @since 7.0.0

View File

@ -37,7 +37,7 @@ interface ISearch {
* @param string $query * @param string $query
* @param string[] $inApps optionally limit results to the given apps * @param string[] $inApps optionally limit results to the given apps
* @return array An array of OCP\Search\Result's * @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 * @since 7.0.0 - parameter $inApps was added in 8.0.0
*/ */
public function search($query, array $inApps = array()); public function search($query, array $inApps = array());

View File

@ -175,7 +175,7 @@ interface IServerContainer {
/** /**
* Returns an instance of the db facade * 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 * @return \OCP\IDb
* @since 7.0.0 * @since 7.0.0
*/ */
@ -334,7 +334,7 @@ interface IServerContainer {
/** /**
* Returns an instance of the HTTP helper class * Returns an instance of the HTTP helper class
* @return \OC\HTTPHelper * @return \OC\HTTPHelper
* @deprecated Use \OCP\Http\Client\IClientService * @deprecated 8.1.0 Use \OCP\Http\Client\IClientService
* @since 8.0.0 * @since 8.0.0
*/ */
public function getHTTPHelper(); public function getHTTPHelper();

View File

@ -36,14 +36,14 @@ namespace OCP;
/** /**
* This class provides convenient functions to generate and send JSON data. Useful for Ajax calls * 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 { class JSON {
/** /**
* Encode and print $data in JSON format * Encode and print $data in JSON format
* @param array $data The data to use * @param array $data The data to use
* @param bool $setContentType the optional content type * @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 ) { public static function encodedPrint( $data, $setContentType=true ) {
\OC_JSON::encodedPrint($data, $setContentType); \OC_JSON::encodedPrint($data, $setContentType);
@ -61,7 +61,7 @@ class JSON {
* *
* Add this call to the start of all ajax method files that requires * Add this call to the start of all ajax method files that requires
* an authenticated user. * 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() { public static function checkLoggedIn() {
\OC_JSON::checkLoggedIn(); \OC_JSON::checkLoggedIn();
@ -84,7 +84,7 @@ class JSON {
* a submittable form, you will need to add the requesttoken first as a * 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 * parameter to the ajax call, then assign it to the template and finally
* add a hidden input field also named 'requesttoken' containing the value. * 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() { public static function callCheck() {
\OC_JSON::callCheck(); \OC_JSON::callCheck();
@ -98,7 +98,7 @@ class JSON {
* *
* @param array $data The data to use * @param array $data The data to use
* @return string json formatted string. * @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() ) { public static function success( $data = array() ) {
\OC_JSON::success($data); \OC_JSON::success($data);
@ -121,7 +121,7 @@ class JSON {
* *
* @param array $data The data to use * @param array $data The data to use
* @return string json formatted error string. * @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() ) { public static function error( $data = array() ) {
\OC_JSON::error( $data ); \OC_JSON::error( $data );
@ -130,7 +130,7 @@ class JSON {
/** /**
* Set Content-Type header to jsonrequest * Set Content-Type header to jsonrequest
* @param string $type The content type header * @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' ) { public static function setContentTypeHeader( $type='application/json' ) {
\OC_JSON::setContentTypeHeader($type); \OC_JSON::setContentTypeHeader($type);
@ -150,7 +150,7 @@ class JSON {
* a specific app to be enabled. * a specific app to be enabled.
* *
* @param string $app The app to check * @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 ) { public static function checkAppEnabled( $app ) {
\OC_JSON::checkAppEnabled($app); \OC_JSON::checkAppEnabled($app);
@ -169,7 +169,7 @@ class JSON {
* Add this call to the start of all ajax method files that requires * Add this call to the start of all ajax method files that requires
* administrative rights. * 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() { public static function checkAdminUser() {
\OC_JSON::checkAdminUser(); \OC_JSON::checkAdminUser();
@ -179,7 +179,7 @@ class JSON {
* Encode JSON * Encode JSON
* @param array $data * @param array $data
* @return string * @return string
* @deprecated Use a AppFramework JSONResponse instead * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
*/ */
public static function encode($data) { public static function encode($data) {
return \OC_JSON::encode($data); return \OC_JSON::encode($data);
@ -188,7 +188,7 @@ class JSON {
/** /**
* Check is a given user exists - send json error msg if not * Check is a given user exists - send json error msg if not
* @param string $user * @param string $user
* @deprecated Use a AppFramework JSONResponse instead * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
*/ */
public static function checkUserExists($user) { public static function checkUserExists($user) {
\OC_JSON::checkUserExists($user); \OC_JSON::checkUserExists($user);

View File

@ -47,7 +47,7 @@ namespace OCP;
* @return string to the image * @return string to the image
* *
* @see OC_Helper::imagePath * @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 ) { function image_path( $app, $image ) {
return(\image_path( $app, $image )); return(\image_path( $app, $image ));
@ -58,7 +58,7 @@ function image_path( $app, $image ) {
* Make OC_Helper::mimetypeIcon available as a simple function * Make OC_Helper::mimetypeIcon available as a simple function
* @param string $mimetype * @param string $mimetype
* @return string to the image of this file type. * @return string to the image of this file type.
* @deprecated Use \OCP\Template::mimetype_icon() instead * @deprecated 8.0.0 Use \OCP\Template::mimetype_icon() instead
*/ */
function mimetype_icon( $mimetype ) { function mimetype_icon( $mimetype ) {
return(\mimetype_icon( $mimetype )); return(\mimetype_icon( $mimetype ));
@ -68,7 +68,7 @@ function mimetype_icon( $mimetype ) {
* Make preview_icon available as a simple function * Make preview_icon available as a simple function
* @param string $path path to file * @param string $path path to file
* @return string to the preview of the image * @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 ) { function preview_icon( $path ) {
return(\preview_icon( $path )); return(\preview_icon( $path ));
@ -80,7 +80,7 @@ function preview_icon( $path ) {
* @param string $path of file * @param string $path of file
* @param string $token * @param string $token
* @return string link to the preview * @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 ) { function publicPreview_icon ( $path, $token ) {
return(\publicPreview_icon( $path, $token )); return(\publicPreview_icon( $path, $token ));
@ -91,7 +91,7 @@ function publicPreview_icon ( $path, $token ) {
* Example: 2048 to 2 kB. * Example: 2048 to 2 kB.
* @param int $bytes in bytes * @param int $bytes in bytes
* @return string size as string * @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 ) { function human_file_size( $bytes ) {
return(\human_file_size( $bytes )); return(\human_file_size( $bytes ));
@ -104,7 +104,7 @@ function human_file_size( $bytes ) {
* @param boolean $dateOnly * @param boolean $dateOnly
* @return \OC_L10N_String human readable interpretation of the timestamp * @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 ) { function relative_modified_date( $timestamp, $dateOnly = false ) {
return(\relative_modified_date($timestamp, null, $dateOnly)); return(\relative_modified_date($timestamp, null, $dateOnly));
@ -115,7 +115,7 @@ function relative_modified_date( $timestamp, $dateOnly = false ) {
* Return a human readable outout for a file size. * Return a human readable outout for a file size.
* @param integer $bytes size of a file in byte * @param integer $bytes size of a file in byte
* @return string human readable interpretation of a file size * @return string human readable interpretation of a file size
* @deprecated Use \OCP\Template::human_file_size() instead * @deprecated 8.0.0 Use \OCP\Template::human_file_size() instead
*/ */
function simple_file_size($bytes) { function simple_file_size($bytes) {
return(\human_file_size($bytes)); return(\human_file_size($bytes));
@ -128,7 +128,7 @@ function simple_file_size($bytes) {
* @param mixed $selected which one is selected? * @param mixed $selected which one is selected?
* @param array $params the parameters * @param array $params the parameters
* @return string html options * @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()) { function html_select_options($options, $selected, $params=array()) {
return(\html_select_options($options, $selected, $params)); return(\html_select_options($options, $selected, $params));

View File

@ -48,7 +48,7 @@ class User {
/** /**
* 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 * @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 * @since 5.0.0
*/ */
public static function getUser() { public static function getUser() {
@ -111,7 +111,7 @@ class User {
/** /**
* Logs the user out including all the session data * Logs the user out including all the session data
* Logout, destroys session * Logout, destroys session
* @deprecated Use \OC::$server->getUserSession()->logout(); * @deprecated 8.0.0 Use \OC::$server->getUserSession()->logout();
* @since 5.0.0 * @since 5.0.0
*/ */
public static function logout() { public static function logout() {
@ -125,7 +125,7 @@ class User {
* @return string|false username on success, false otherwise * @return string|false username on success, false otherwise
* *
* Check if the password is correct without logging in the user * 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 * @since 5.0.0
*/ */
public static function checkPassword( $uid, $password ) { public static function checkPassword( $uid, $password ) {

View File

@ -83,7 +83,7 @@ class Util {
* @param string $ccaddress * @param string $ccaddress
* @param string $ccname * @param string $ccname
* @param string $bcc * @param string $bcc
* @deprecated Use \OCP\Mail\IMailer instead * @deprecated 8.1.0 Use \OCP\Mail\IMailer instead
* @since 4.0.0 * @since 4.0.0
*/ */
public static function sendMail($toaddress, $toname, $subject, $mailtext, $fromaddress, $fromname, public static function sendMail($toaddress, $toname, $subject, $mailtext, $fromaddress, $fromname,
@ -222,7 +222,7 @@ class Util {
* @param DateTimeZone|string $timeZone where the given timestamp shall be converted to * @param DateTimeZone|string $timeZone where the given timestamp shall be converted to
* @return string timestamp * @return string timestamp
* *
* @deprecated Use \OC::$server->query('DateTimeFormatter') instead * @deprecated 8.0.0 Use \OC::$server->query('DateTimeFormatter') instead
* @since 4.0.0 * @since 4.0.0
*/ */
public static function formatDate($timestamp, $dateOnly=false, $timeZone = null) { public static function formatDate($timestamp, $dateOnly=false, $timeZone = null) {
@ -233,7 +233,7 @@ class Util {
* check if some encrypted files are stored * check if some encrypted files are stored
* @return bool * @return bool
* *
* @deprecated No longer required * @deprecated 8.1.0 No longer required
* @since 6.0.0 * @since 6.0.0
*/ */
public static function encryptedFiles() { public static function encryptedFiles() {
@ -279,7 +279,7 @@ class Util {
* @param array $parameters * @param array $parameters
* @internal param array $args with param=>value, will be appended to the returned url * @internal param array $args with param=>value, will be appended to the returned url
* @return string the url * @return string the url
* @deprecated Use \OC::$server->getURLGenerator()->linkToRoute($route, $parameters) * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkToRoute($route, $parameters)
* @since 5.0.0 * @since 5.0.0
*/ */
public static function linkToRoute( $route, $parameters = array() ) { public static function linkToRoute( $route, $parameters = array() ) {
@ -293,7 +293,7 @@ class Util {
* @param array $args array with param=>value, will be appended to the returned url * @param array $args array with param=>value, will be appended to the returned url
* The value of $args will be urlencoded * The value of $args will be urlencoded
* @return string the url * @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 * @since 4.0.0 - parameter $args was added in 4.5.0
*/ */
public static function linkTo( $app, $file, $args = array() ) { public static function linkTo( $app, $file, $args = array() ) {
@ -303,7 +303,7 @@ class Util {
/** /**
* Returns the server host, even if the website uses one or more reverse proxy * Returns the server host, even if the website uses one or more reverse proxy
* @return string the server host * @return string the server host
* @deprecated Use \OCP\IRequest::getServerHost * @deprecated 8.1.0 Use \OCP\IRequest::getServerHost
* @since 4.0.0 * @since 4.0.0
*/ */
public static function getServerHost() { public static function getServerHost() {
@ -359,7 +359,7 @@ class Util {
/** /**
* Returns the server protocol. It respects reverse proxy servers and load balancers * Returns the server protocol. It respects reverse proxy servers and load balancers
* @return string the server protocol * @return string the server protocol
* @deprecated Use \OCP\IRequest::getServerProtocol * @deprecated 8.1.0 Use \OCP\IRequest::getServerProtocol
* @since 4.5.0 * @since 4.5.0
*/ */
public static function getServerProtocol() { public static function getServerProtocol() {
@ -369,7 +369,7 @@ class Util {
/** /**
* Returns the request uri, even if the website uses one or more reverse proxies * Returns the request uri, even if the website uses one or more reverse proxies
* @return string the request uri * @return string the request uri
* @deprecated Use \OCP\IRequest::getRequestUri * @deprecated 8.1.0 Use \OCP\IRequest::getRequestUri
* @since 5.0.0 * @since 5.0.0
*/ */
public static function getRequestUri() { public static function getRequestUri() {
@ -379,7 +379,7 @@ class Util {
/** /**
* Returns the script name, even if the website uses one or more reverse proxies * Returns the script name, even if the website uses one or more reverse proxies
* @return string the script name * @return string the script name
* @deprecated Use \OCP\IRequest::getScriptName * @deprecated 8.1.0 Use \OCP\IRequest::getScriptName
* @since 5.0.0 * @since 5.0.0
*/ */
public static function getScriptName() { public static function getScriptName() {
@ -391,7 +391,7 @@ class Util {
* @param string $app app * @param string $app app
* @param string $image image name * @param string $image image name
* @return string the url * @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 * @since 4.0.0
*/ */
public static function imagePath( $app, $image ) { public static function imagePath( $app, $image ) {
@ -591,7 +591,7 @@ class Util {
* Returns whether the given file name is valid * Returns whether the given file name is valid
* @param string $file file name to check * @param string $file file name to check
* @return bool true if the file name is valid, false otherwise * @return bool true if the file name is valid, false otherwise
* @deprecated use \OC\Files\View::verifyPath() * @deprecated 8.1.0 use \OC\Files\View::verifyPath()
* @since 7.0.0 * @since 7.0.0
*/ */
public static function isValidFileName($file) { public static function isValidFileName($file) {
@ -602,7 +602,7 @@ class Util {
* Generates a cryptographic secure pseudo-random string * Generates a cryptographic secure pseudo-random string
* @param int $length of the random string * @param int $length of the random string
* @return string * @return string
* @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 * @since 7.0.0
*/ */
public static function generateRandomBytes($length = 30) { public static function generateRandomBytes($length = 30) {