sascha
/
nextcloud-server
mirror of https://github.com/nextcloud/server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add @since tags to all methods in public namespace 

* enhance the app development experience - you can look up the
  method introduction right inside the code without searching
  via git blame
* easier to write apps for multiple versions
remotes/origin/poc-doctrine-migrations
Morris Jobke 2015-04-16 17:00:08 +07:00
parent 8653da6c16
commit 7644950b48
141 changed files with 1373 additions and 152 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lib/public/activity/iconsumer.php
Unescape Escape View File

@ -29,6 +29,12 @@
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP\Activity;
/**
* Interface IConsumer
*
* @package OCP\Activity
* @since 6.0.0
*/
interface IConsumer {
/**
* @param $app
@ -42,6 +48,7 @@ interface IConsumer {
* @param $type
* @param $priority
* @return mixed
* @since 6.0.0
*/
function receive($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority );
}

16
lib/public/activity/iextension.php
Unescape Escape View File

@ -31,6 +31,12 @@
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP\Activity;
/**
* Interface IExtension
*
* @package OCP\Activity
* @since 8.0.0
*/
interface IExtension {
const PRIORITY_VERYLOW = 10;
@ -45,6 +51,7 @@ interface IExtension {
*
* @param string $languageCode
* @return array|false
* @since 8.0.0
*/
public function getNotificationTypes($languageCode);
@ -54,6 +61,7 @@ interface IExtension {
*
* @param string $method
* @return array|false
* @since 8.0.0
*/
public function getDefaultTypes($method);
@ -63,6 +71,7 @@ interface IExtension {
*
* @param string $type
* @return string|false
* @since 8.0.0
*/
public function getTypeIcon($type);
@ -77,6 +86,7 @@ interface IExtension {
* @param boolean $highlightParams
* @param string $languageCode
* @return string|false
* @since 8.0.0
*/
public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
@ -90,6 +100,7 @@ interface IExtension {
* @param string $app
* @param string $text
* @return array|false
* @since 8.0.0
*/
public function getSpecialParameterList($app, $text);
@ -99,6 +110,7 @@ interface IExtension {
*
* @param array $activity
* @return integer|false
* @since 8.0.0
*/
public function getGroupParameter($activity);
@ -108,6 +120,7 @@ interface IExtension {
* If no further entries are to be added false is no be returned.
*
* @return array|false
* @since 8.0.0
*/
public function getNavigation();
@ -116,6 +129,7 @@ interface IExtension {
*
* @param string $filterValue
* @return boolean
* @since 8.0.0
*/
public function isFilterValid($filterValue);
@ -126,6 +140,7 @@ interface IExtension {
* @param array $types
* @param string $filter
* @return array|false
* @since 8.0.0
*/
public function filterNotificationTypes($types, $filter);
@ -137,6 +152,7 @@ interface IExtension {
*
* @param string $filter
* @return array|false
* @since 8.0.0
*/
public function getQueryForFilter($filter);
}

20
lib/public/activity/imanager.php
Unescape Escape View File

@ -31,6 +31,12 @@
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP\Activity;
/**
* Interface IManager
*
* @package OCP\Activity
* @since 6.0.0
*/
interface IManager {
/**
@ -45,6 +51,7 @@ interface IManager {
* @param $type
* @param $priority
* @return mixed
* @since 6.0.0
*/
function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority);
@ -56,6 +63,7 @@ interface IManager {
*
* @param \Closure $callable
* @return void
* @since 6.0.0
*/
function registerConsumer(\Closure $callable);
@ -67,6 +75,7 @@ interface IManager {
*
* @param \Closure $callable
* @return void
* @since 8.0.0
*/
function registerExtension(\Closure $callable);
@ -74,18 +83,21 @@ interface IManager {
* Will return additional notification types as specified by other apps
* @param string $languageCode
* @return array
* @since 8.0.0
*/
function getNotificationTypes($languageCode);
/**
* @param string $method
* @return array
* @since 8.0.0
*/
function getDefaultTypes($method);
/**
* @param string $type
* @return string
* @since 8.0.0
*/
function getTypeIcon($type);
@ -97,6 +109,7 @@ interface IManager {
* @param boolean $highlightParams
* @param string $languageCode
* @return string|false
* @since 8.0.0
*/
function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
@ -104,23 +117,27 @@ interface IManager {
* @param string $app
* @param string $text
* @return array|false
* @since 8.0.0
*/
function getSpecialParameterList($app, $text);
/**
* @param array $activity
* @return integer|false
* @since 8.0.0
*/
function getGroupParameter($activity);
/**
* @return array
* @since 8.0.0
*/
function getNavigation();
/**
* @param string $filterValue
* @return boolean
* @since 8.0.0
*/
function isFilterValid($filterValue);
@ -128,12 +145,14 @@ interface IManager {
* @param array $types
* @param string $filter
* @return array
* @since 8.0.0
*/
function filterNotificationTypes($types, $filter);
/**
* @param string $filter
* @return array
* @since 8.0.0
*/
function getQueryForFilter($filter);
@ -144,6 +163,7 @@ interface IManager {
*
* @return string
* @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
* @since 8.1.0
*/
public function getCurrentUserId();
}

2
lib/public/api.php
Unescape Escape View File

@ -33,6 +33,7 @@ namespace OCP;
/**
* This class provides functions to manage apps in ownCloud
* @since 5.0.0
*/
class API {
@ -45,6 +46,7 @@ class API {
* @param int $authLevel the level of authentication required for the call (See OC_API constants)
* @param array $defaults
* @param array $requirements
* @since 5.0.0
*/
public static function register($method, $url, $action, $app, $authLevel = OC_API::USER_AUTH,
$defaults = array(), $requirements = array()){

9
lib/public/app.php
Unescape Escape View File

@ -38,6 +38,7 @@ namespace OCP;
/**
* This class provides functions to manage apps in ownCloud
* @since 4.0.0
*/
class App {
/**
@ -73,6 +74,7 @@ class App {
*
* @deprecated Use \OC::$server->getNavigationManager()->add() instead to
* register a closure, this helps to speed up all requests against ownCloud
* @since 4.0.0
*/
public static function addNavigationEntry($data) {
\OC::$server->getNavigationManager()->add($data);
@ -89,6 +91,7 @@ class App {
* highlighting the current position of the user.
*
* @deprecated Use \OC::$server->getNavigationManager()->setActiveEntry() instead
* @since 4.0.0
*/
public static function setActiveNavigationEntry( $id ) {
return \OC_App::setActiveNavigationEntry( $id );
@ -99,6 +102,7 @@ class App {
* @param string $app appid
* @param string $page page to be included
* @return void
* @since 4.0.0
*/
public static function registerPersonal( $app, $page ) {
\OC_App::registerPersonal( $app, $page );
@ -109,6 +113,7 @@ class App {
* @param string $app string appid
* @param string $page string page to be included
* @return void
* @since 4.0.0
*/
public static function registerAdmin( $app, $page ) {
\OC_App::registerAdmin( $app, $page );
@ -119,6 +124,7 @@ class App {
* @param string $app id of the app or the path of the info.xml file
* @param boolean $path (optional)
* @return array
* @since 4.0.0
*/
public static function getAppInfo( $app, $path=false ) {
return \OC_App::getAppInfo( $app, $path);
@ -130,6 +136,7 @@ class App {
* @return boolean
*
* This function checks whether or not an app is enabled.
* @since 4.0.0
*/
public static function isEnabled( $app ) {
return \OC_App::isEnabled( $app );
@ -139,6 +146,7 @@ class App {
* Check if the app is enabled, redirects to home if not
* @param string $app
* @return void
* @since 4.0.0
*/
public static function checkAppEnabled( $app ) {
\OC_Util::checkAppEnabled( $app );
@ -148,6 +156,7 @@ class App {
* Get the last version of the app, either from appinfo/version or from appinfo/info.xml
* @param string $app
* @return string
* @since 4.0.0
*/
public static function getAppVersion( $app ) {
return \OC_App::getAppVersion( $app );

14
lib/public/app/iappmanager.php
Unescape Escape View File

@ -24,6 +24,12 @@ namespace OCP\App;
use OCP\IUser;
/**
* Interface IAppManager
*
* @package OCP\App
* @since 8.0.0
*/
interface IAppManager {
/**
* Check if an app is enabled for user
@ -31,6 +37,7 @@ interface IAppManager {
* @param string $appId
* @param \OCP\IUser $user (optional) if not defined, the currently loggedin user will be used
* @return bool
* @since 8.0.0
*/
public function isEnabledForUser($appId, $user = null);
@ -39,6 +46,7 @@ interface IAppManager {
*
* @param string $appId
* @return bool
* @since 8.0.0
*/
public function isInstalled($appId);
@ -46,6 +54,7 @@ interface IAppManager {
* Enable an app for every user
*
* @param string $appId
* @since 8.0.0
*/
public function enableApp($appId);
@ -54,6 +63,7 @@ interface IAppManager {
*
* @param string $appId
* @param \OCP\IGroup[] $groups
* @since 8.0.0
*/
public function enableAppForGroups($appId, $groups);
@ -61,6 +71,7 @@ interface IAppManager {
* Disable an app for every user
*
* @param string $appId
* @since 8.0.0
*/
public function disableApp($appId);
@ -69,6 +80,7 @@ interface IAppManager {
*
* @param \OCP\IUser $user
* @return string[]
* @since 8.1.0
*/
public function getEnabledAppsForUser(IUser $user);
@ -76,11 +88,13 @@ interface IAppManager {
* List all installed apps
*
* @return string[]
* @since 8.0.0
*/
public function getInstalledApps();
/**
* Clear the cached list of apps when enabling/disabling an app
* @since 8.1.0
*/
public function clearAppsCache();
}

3
lib/public/appframework/apicontroller.php
Unescape Escape View File

@ -33,6 +33,7 @@ use OCP\IRequest;
/**
* Base class to inherit your controllers from that are used for RESTful APIs
* @since 7.0.0
*/
abstract class ApiController extends Controller {
@ -52,6 +53,7 @@ abstract class ApiController extends Controller {
* defaults to 'Authorization, Content-Type, Accept'
* @param int $corsMaxAge number in seconds how long a preflighted OPTIONS
* request should be cached, defaults to 1728000 seconds
* @since 7.0.0
*/
public function __construct($appName,
IRequest $request,
@ -72,6 +74,7 @@ abstract class ApiController extends Controller {
* @NoAdminRequired
* @NoCSRFRequired
* @PublicPage
* @since 7.0.0
*/
public function preflightedCors() {
if(isset($this->request->server['HTTP_ORIGIN'])) {

6
lib/public/appframework/app.php
Unescape Escape View File

@ -38,6 +38,7 @@ use OC\AppFramework\routing\RouteConfig;
*
* Any application must inherit this call - all controller instances to be used are
* to be registered using IContainer::registerService
* @since 6.0.0
*/
class App {
@ -50,6 +51,7 @@ class App {
* @param string $topNamespace the namespace which should be prepended to
* the transformed app id, defaults to OCA\
* @return string the starting namespace for the app
* @since 8.0.0
*/
public static function buildAppNamespace($appId, $topNamespace='OCA\\') {
return \OC\AppFramework\App::buildAppNamespace($appId, $topNamespace);
@ -58,6 +60,7 @@ class App {
/**
* @param array $urlParams an array with variables extracted from the routes
* @since 6.0.0
*/
public function __construct($appName, $urlParams = array()) {
$this->container = new \OC\AppFramework\DependencyInjection\DIContainer($appName, $urlParams);
@ -67,6 +70,7 @@ class App {
/**
* @return IAppContainer
* @since 6.0.0
*/
public function getContainer() {
return $this->container;
@ -88,6 +92,7 @@ class App {
*
* @param \OCP\Route\IRouter $router
* @param array $routes
* @since 6.0.0
*/
public function registerRoutes($router, $routes) {
$routeConfig = new RouteConfig($this->container, $router, $routes);
@ -123,6 +128,7 @@ class App {
* @param string $controllerName the name of the controller under which it is
* stored in the DI container
* @param string $methodName the method that you want to call
* @since 6.0.0
*/
public function dispatch($controllerName, $methodName) {
\OC\AppFramework\App::main($controllerName, $methodName, $this->container);

19
lib/public/appframework/controller.php
Unescape Escape View File

@ -34,32 +34,41 @@ namespace OCP\AppFramework;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\AppFramework\Http\JSONResponse;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Http\Response;
use OCP\IRequest;
/**
* Base class to inherit your controllers from
* @since 6.0.0
*/
abstract class Controller {
/**
* app name
* @var string
* @since 7.0.0
*/
protected $appName;
/**
* current request
* @var \OCP\IRequest
* @since 6.0.0
*/
protected $request;
/**
* @var array
* @since 7.0.0
*/
private $responders;
/**
* constructor of the controller
* @param string $appName the name of the app
* @param IRequest $request an instance of the request
* @since 6.0.0 - parameter $appName was added in 7.0.0 - parameter $app was removed in 7.0.0
*/
public function __construct($appName,
IRequest $request){
@ -88,6 +97,7 @@ abstract class Controller {
* Parses an HTTP accept header and returns the supported responder type
* @param string $acceptHeader
* @return string the responder type
* @since 7.0.0
*/
public function getResponderByHTTPHeader($acceptHeader) {
$headers = explode(',', $acceptHeader);
@ -112,6 +122,7 @@ abstract class Controller {
* Registers a formatter for a type
* @param string $format
* @param \Closure $responder
* @since 7.0.0
*/
protected function registerResponder($format, \Closure $responder) {
$this->responders[$format] = $responder;
@ -125,6 +136,7 @@ abstract class Controller {
* @param string $format the format for which a formatter has been registered
* @throws \DomainException if format does not match a registered formatter
* @return Response
* @since 7.0.0
*/
public function buildResponse($response, $format='json') {
if(array_key_exists($format, $this->responders)) {
@ -151,6 +163,7 @@ abstract class Controller {
* 3. GET parameters
* @param string $default If the key is not found, this value will be returned
* @return mixed the content of the array
* @since 6.0.0
*/
public function params($key, $default=null){
return $this->request->getParam($key, $default);
@ -162,6 +175,7 @@ abstract class Controller {
* (as GET or POST) or through the URL by the route
* @deprecated use $this->request instead
* @return array the array with all parameters
* @since 6.0.0
*/
public function getParams() {
return $this->request->getParams();
@ -172,6 +186,7 @@ abstract class Controller {
* Returns the method of the request
* @deprecated use $this->request instead
* @return string the method of the request (POST, GET, etc)
* @since 6.0.0
*/
public function method() {
return $this->request->getMethod();
@ -183,6 +198,7 @@ abstract class Controller {
* @deprecated 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
*/
public function getUploadedFile($key) {
return $this->request->getUploadedFile($key);
@ -194,6 +210,7 @@ abstract class Controller {
* @deprecated 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
*/
public function env($key) {
return $this->request->getEnv($key);
@ -205,6 +222,7 @@ abstract class Controller {
* @deprecated 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
*/
public function cookie($key) {
return $this->request->getCookie($key);
@ -220,6 +238,7 @@ abstract class Controller {
* admin an entry in the admin settings
* @param string[] $headers set additional headers in name/value pairs
* @return \OCP\AppFramework\Http\TemplateResponse containing the page
* @since 6.0.0
*/
public function render($templateName, array $params=array(),
$renderAs='user', array $headers=array()){

3
lib/public/appframework/db/doesnotexistexception.php
Unescape Escape View File

@ -27,6 +27,7 @@ namespace OCP\AppFramework\Db;
/**
* This is returned or should be returned when a find request does not find an
* entry in the database
* @since 7.0.0
*/
class DoesNotExistException extends \Exception {
@ -38,4 +39,4 @@ class DoesNotExistException extends \Exception {
parent::__construct($msg);
}
}
}

14
lib/public/appframework/db/entity.php
Unescape Escape View File

@ -26,6 +26,7 @@ namespace OCP\AppFramework\Db;
/**
* @method integer getId()
* @method void setId(integer $id)
* @since 7.0.0
*/
abstract class Entity {
@ -40,6 +41,7 @@ abstract class Entity {
* @param array $params the array which was obtained via $this->params('key')
* in the controller
* @return Entity
* @since 7.0.0
*/
public static function fromParams(array $params) {
$instance = new static();
@ -56,6 +58,7 @@ abstract class Entity {
/**
* Maps the keys of the row array to the attributes
* @param array $row the row to map onto the entity
* @since 7.0.0
*/
public static function fromRow(array $row){
$instance = new static();
@ -73,7 +76,8 @@ abstract class Entity {
/**
* @return an array with attribute and type
* @return array with attribute and type
* @since 7.0.0
*/
public function getFieldTypes() {
return $this->_fieldTypes;
@ -82,12 +86,12 @@ abstract class Entity {
/**
* Marks the entity as clean needed for setting the id after the insertion
* @since 7.0.0
*/
public function resetUpdatedFields(){
$this->_updatedFields = array();
}
protected function setter($name, $args) {
// setters should only work for existing attributes
if(property_exists($this, $name)){
@ -108,7 +112,6 @@ abstract class Entity {
}
}
protected function getter($name) {
// getters should only work for existing attributes
if(property_exists($this, $name)){
@ -125,6 +128,7 @@ abstract class Entity {
* into an array: for instance setId will save Id in the
* updated fields array so it can be easily used to create the
* getter method
* @since 7.0.0
*/
public function __call($methodName, $args){
$attr = lcfirst( substr($methodName, 3) );
@ -154,6 +158,7 @@ abstract class Entity {
* Transform a database columnname to a property
* @param string $columnName the name of the column
* @return string the property name
* @since 7.0.0
*/
public function columnToProperty($columnName){
$parts = explode('_', $columnName);
@ -175,6 +180,7 @@ abstract class Entity {
* Transform a property to a database column name
* @param string $property the name of the property
* @return string the column name
* @since 7.0.0
*/
public function propertyToColumn($property){
$parts = preg_split('/(?=[A-Z])/', $property);
@ -194,6 +200,7 @@ abstract class Entity {
/**
* @return array array of updated fields for update query
* @since 7.0.0
*/
public function getUpdatedFields(){
return $this->_updatedFields;
@ -216,6 +223,7 @@ abstract class Entity {
* Warning: This doesn't result in a unique value
* @param string $attributeName the name of the attribute, which value should be slugified
* @return string slugified value
* @since 7.0.0
*/
public function slugify($attributeName){
// toSlug should only work for existing attributes

11
lib/public/appframework/db/mapper.php
Unescape Escape View File

@ -32,6 +32,7 @@ use OCP\IDb;
/**
* Simple parent class for inheriting your data access layer from. This class
* may be subject to change in the future
* @since 7.0.0
*/
abstract class Mapper {
@ -44,6 +45,7 @@ abstract class Mapper {
* @param string $tableName the name of the table. set this to allow entity
* @param string $entityClass the name of the entity that the sql should be
* mapped to queries without using sql
* @since 7.0.0
*/
public function __construct(IDBConnection $db, $tableName, $entityClass=null){
$this->db = $db;
@ -61,6 +63,7 @@ abstract class Mapper {
/**
* @return string the table name
* @since 7.0.0
*/
public function getTableName(){
return $this->tableName;
@ -71,6 +74,7 @@ abstract class Mapper {
* Deletes an entity from the table
* @param Entity $entity the entity that should be deleted
* @return Entity the deleted entity
* @since 7.0.0 - return value added in 8.1.0
*/
public function delete(Entity $entity){
$sql = 'DELETE FROM `' . $this->tableName . '` WHERE `id` = ?';
@ -84,6 +88,7 @@ abstract class Mapper {
* Creates a new entry in the db from an entity
* @param Entity $entity the entity that should be created
* @return Entity the saved entity with the set id
* @since 7.0.0
*/
public function insert(Entity $entity){
// get updated fields to save, fields have to be set using a setter to
@ -132,6 +137,7 @@ abstract class Mapper {
* @throws \InvalidArgumentException if entity has no id
* @param Entity $entity the entity that should be created
* @return Entity the saved entity with the set id
* @since 7.0.0 - return value was added in 8.0.0
*/
public function update(Entity $entity){
// if entity wasn't changed it makes no sense to run a db query
@ -216,6 +222,7 @@ abstract class Mapper {
* @param int $limit the maximum number of rows
* @param int $offset from which row we want to start
* @return \PDOStatement the database query result
* @since 7.0.0
*/
protected function execute($sql, array $params=[], $limit=null, $offset=null){
if ($this->db instanceof IDb) {
@ -264,6 +271,7 @@ abstract class Mapper {
* @throws DoesNotExistException if the item does not exist
* @throws MultipleObjectsReturnedException if more than one item exist
* @return array the result as row
* @since 7.0.0
*/
protected function findOneQuery($sql, array $params=[], $limit=null, $offset=null){
$stmt = $this->execute($sql, $params, $limit, $offset);
@ -289,6 +297,7 @@ abstract class Mapper {
* from the current mapper name (MyEntityMapper -> MyEntity)
* @param array $row the row which should be converted to an entity
* @return Entity the entity
* @since 7.0.0
*/
protected function mapRowToEntity($row) {
return call_user_func($this->entityClass .'::fromRow', $row);
@ -302,6 +311,7 @@ abstract class Mapper {
* @param int $limit the maximum number of rows
* @param int $offset from which row we want to start
* @return array all fetched entities
* @since 7.0.0
*/
protected function findEntities($sql, array $params=[], $limit=null, $offset=null) {
$stmt = $this->execute($sql, $params, $limit, $offset);
@ -328,6 +338,7 @@ abstract class Mapper {
* @throws DoesNotExistException if the item does not exist
* @throws MultipleObjectsReturnedException if more than one item exist
* @return Entity the entity
* @since 7.0.0
*/
protected function findEntity($sql, array $params=[], $limit=null, $offset=null){
return $this->mapRowToEntity($this->findOneQuery($sql, $params, $limit, $offset));

3
lib/public/appframework/db/multipleobjectsreturnedexception.php
Unescape Escape View File

@ -27,6 +27,7 @@ namespace OCP\AppFramework\Db;
/**
* This is returned or should be returned when a find request finds more than one
* row
* @since 7.0.0
*/
class MultipleObjectsReturnedException extends \Exception {
@ -38,4 +39,4 @@ class MultipleObjectsReturnedException extends \Exception {
parent::__construct($msg);
}
}
}

1
lib/public/appframework/http.php
Unescape Escape View File

@ -30,6 +30,7 @@ namespace OCP\AppFramework;
/**
* Base class which contains constants for HTTP status codes
* @since 6.0.0
*/
class Http {

14
lib/public/appframework/http/contentsecuritypolicy.php
Unescape Escape View File

@ -35,6 +35,7 @@ use OCP\AppFramework\Http;
* should require no modification at all for most use-cases.
*
* @package OCP\AppFramework\Http
* @since 8.1.0
*/
class ContentSecurityPolicy {
/** @var bool Whether inline JS snippets are allowed */
@ -86,6 +87,7 @@ class ContentSecurityPolicy {
* Whether inline JavaScript snippets are allowed or forbidden
* @param bool $state
* @return $this
* @since 8.1.0
*/
public function allowInlineScript($state = false) {
$this->inlineScriptAllowed = $state;
@ -96,6 +98,7 @@ class ContentSecurityPolicy {
* Whether eval in JavaScript is allowed or forbidden
* @param bool $state
* @return $this
* @since 8.1.0
*/
public function allowEvalScript($state = true) {
$this->evalScriptAllowed= $state;
@ -107,6 +110,7 @@ class ContentSecurityPolicy {
* allow JavaScript from all domains.
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
* @return $this
* @since 8.1.0
*/
public function addAllowedScriptDomain($domain) {
$this->allowedScriptDomains[] = $domain;
@ -117,6 +121,7 @@ class ContentSecurityPolicy {
* Whether inline CSS snippets are allowed or forbidden
* @param bool $state
* @return $this
* @since 8.1.0
*/
public function allowInlineStyle($state = true) {
$this->inlineStyleAllowed = $state;
@ -128,6 +133,7 @@ class ContentSecurityPolicy {
* CSS from all domains.
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
* @return $this
* @since 8.1.0
*/
public function addAllowedStyleDomain($domain) {
$this->allowedStyleDomains[] = $domain;
@ -139,6 +145,7 @@ class ContentSecurityPolicy {
* fonts from all domains.
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
* @return $this
* @since 8.1.0
*/
public function addAllowedFontDomain($domain) {
$this->allowedFontDomains[] = $domain;
@ -150,6 +157,7 @@ class ContentSecurityPolicy {
* images from all domains.
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
* @return $this
* @since 8.1.0
*/
public function addAllowedImageDomain($domain) {
$this->allowedImageDomains[] = $domain;
@ -160,6 +168,7 @@ class ContentSecurityPolicy {
* To which remote domains the JS connect to.
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
* @return $this
* @since 8.1.0
*/
public function addAllowedConnectDomain($domain) {
$this->allowedConnectDomains[] = $domain;
@ -170,6 +179,7 @@ class ContentSecurityPolicy {
* From whoch domains media elements can be embedded.
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
* @return $this
* @since 8.1.0
*/
public function addAllowedMediaDomain($domain) {
$this->allowedMediaDomains[] = $domain;
@ -180,6 +190,7 @@ class ContentSecurityPolicy {
* From which domains objects such as <object>, <embed> or <applet> are executed
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
* @return $this
* @since 8.1.0
*/
public function addAllowedObjectDomain($domain) {
$this->allowedObjectDomains[] = $domain;
@ -190,6 +201,7 @@ class ContentSecurityPolicy {
* Which domains can be embedded in an iframe
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
* @return $this
* @since 8.1.0
*/
public function addAllowedFrameDomain($domain) {
$this->allowedFrameDomains[] = $domain;
@ -200,6 +212,7 @@ class ContentSecurityPolicy {
* Domains from which web-workers and nested browsing content can load elements
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
* @return $this
* @since 8.1.0
*/
public function addAllowedChildSrcDomain($domain) {
$this->allowedChildSrcDomains[] = $domain;
@ -209,6 +222,7 @@ class ContentSecurityPolicy {
/**
* Get the generated Content-Security-Policy as a string
* @return string
* @since 8.1.0
*/
public function buildPolicy() {
$policy = "default-src 'none';";

10
lib/public/appframework/http/datadisplayresponse.php
Unescape Escape View File

@ -23,6 +23,12 @@ namespace OCP\AppFramework\Http;
use OCP\AppFramework\Http;
/**
* Class DataDisplayResponse
*
* @package OCP\AppFramework\Http
* @since 8.1.0
*/
class DataDisplayResponse extends Response {
/**
@ -36,6 +42,7 @@ class DataDisplayResponse extends Response {
* @param string $data the data to display
* @param int $statusCode the Http status code, defaults to 200
* @param array $headers additional key value based headers
* @since 8.1.0
*/
public function __construct($data="", $statusCode=Http::STATUS_OK,
$headers=[]) {
@ -48,6 +55,7 @@ class DataDisplayResponse extends Response {
/**
* Outputs data. No processing is done.
* @return string
* @since 8.1.0
*/
public function render() {
return $this->data;
@ -58,6 +66,7 @@ class DataDisplayResponse extends Response {
* Sets values in the data
* @param string $data the data to display
* @return DataDisplayResponse Reference to this object
* @since 8.1.0
*/
public function setData($data){
$this->data = $data;
@ -69,6 +78,7 @@ class DataDisplayResponse extends Response {
/**
* Used to get the set parameters
* @return string the data
* @since 8.1.0
*/
public function getData(){
return $this->data;

9
lib/public/appframework/http/datadownloadresponse.php
Unescape Escape View File

@ -21,6 +21,12 @@
*/
namespace OCP\AppFramework\Http;
/**
* Class DataDownloadResponse
*
* @package OCP\AppFramework\Http
* @since 8.0.0
*/
class DataDownloadResponse extends DownloadResponse {
/**
* @var string
@ -32,6 +38,7 @@ class DataDownloadResponse extends DownloadResponse {
* @param string $data text to be downloaded
* @param string $filename the name that the downloaded file should have
* @param string $contentType the mimetype that the downloaded file should have
* @since 8.0.0
*/
public function __construct($data, $filename, $contentType) {
$this->data = $data;
@ -40,6 +47,7 @@ class DataDownloadResponse extends DownloadResponse {
/**
* @param string $data
* @since 8.0.0
*/
public function setData($data) {
$this->data = $data;
@ -47,6 +55,7 @@ class DataDownloadResponse extends DownloadResponse {
/**
* @return string
* @since 8.0.0
*/
public function render() {
return $this->data;

4
lib/public/appframework/http/dataresponse.php
Unescape Escape View File

@ -32,6 +32,7 @@ use OCP\AppFramework\Http;
/**
* A generic DataResponse class that is used to return generic data responses
* for responders to transform
* @since 8.0.0
*/
class DataResponse extends Response {
@ -46,6 +47,7 @@ class DataResponse extends Response {
* @param array|object $data the object or array that should be transformed
* @param int $statusCode the Http status code, defaults to 200
* @param array $headers additional key value based headers
* @since 8.0.0
*/
public function __construct($data=array(), $statusCode=Http::STATUS_OK,
array $headers=array()) {
@ -59,6 +61,7 @@ class DataResponse extends Response {
* Sets values in the data json array
* @param array|object $data an array or object which will be transformed
* @return DataResponse Reference to this object
* @since 8.0.0
*/
public function setData($data){
$this->data = $data;
@ -70,6 +73,7 @@ class DataResponse extends Response {
/**
* Used to get the set parameters
* @return array the data
* @since 8.0.0
*/
public function getData(){
return $this->data;

2
lib/public/appframework/http/downloadresponse.php
Unescape Escape View File

@ -27,6 +27,7 @@ namespace OCP\AppFramework\Http;
/**
* Prompts the user to download the a file
* @since 7.0.0
*/
class DownloadResponse extends \OCP\AppFramework\Http\Response {
@ -37,6 +38,7 @@ class DownloadResponse extends \OCP\AppFramework\Http\Response {
* Creates a response that prompts the user to download the file
* @param string $filename the name that the downloaded file should have
* @param string $contentType the mimetype that the downloaded file should have
* @since 7.0.0
*/
public function __construct($filename, $contentType) {
$this->filename = $filename;

2
lib/public/appframework/http/icallbackresponse.php
Unescape Escape View File

@ -27,6 +27,7 @@ namespace OCP\AppFramework\Http;
* Interface ICallbackResponse
*
* @package OCP\AppFramework\Http
* @since 8.1.0
*/
interface ICallbackResponse {
@ -34,6 +35,7 @@ interface ICallbackResponse {
* Outputs the content that should be printed
*
* @param IOutput $output a small wrapper that handles output
* @since 8.1.0
*/
function callback(IOutput $output);

7
lib/public/appframework/http/ioutput.php
Unescape Escape View File

@ -24,11 +24,13 @@ namespace OCP\AppFramework\Http;
/**
* Very thin wrapper class to make output testable
* @since 8.1.0
*/
interface IOutput {
/**
* @param string $out
* @since 8.1.0
*/
public function setOutput($out);
@ -36,21 +38,25 @@ interface IOutput {
* @param string $path
*
* @return bool false if an error occured
* @since 8.1.0
*/
public function setReadfile($path);
/**
* @param string $header
* @since 8.1.0
*/
public function setHeader($header);
/**
* @return int returns the current http response code
* @since 8.1.0
*/
public function getHttpResponseCode();
/**
* @param int $code sets the http status code
* @since 8.1.0
*/
public function setHttpResponseCode($code);
@ -62,6 +68,7 @@ interface IOutput {
* @param string $domain
* @param bool $secure
* @param bool $httponly
* @since 8.1.0
*/
public function setCookie($name, $value, $expire, $path, $domain, $secure, $httponly);

5
lib/public/appframework/http/jsonresponse.php
Unescape Escape View File

@ -33,6 +33,7 @@ use OCP\AppFramework\Http;
/**
* A renderer for JSON calls
* @since 6.0.0
*/
class JSONResponse extends Response {
@ -47,6 +48,7 @@ class JSONResponse extends Response {
* constructor of JSONResponse
* @param array|object $data the object or array that should be transformed
* @param int $statusCode the Http status code, defaults to 200
* @since 6.0.0
*/
public function __construct($data=array(), $statusCode=Http::STATUS_OK) {
$this->data = $data;
@ -58,6 +60,7 @@ class JSONResponse extends Response {
/**
* Returns the rendered json
* @return string the rendered json
* @since 6.0.0
*/
public function render(){
return json_encode($this->data);
@ -68,6 +71,7 @@ class JSONResponse extends Response {
* @param array|object $data an array or object which will be transformed
* to JSON
* @return JSONResponse Reference to this object
* @since 6.0.0 - return value was added in 7.0.0
*/
public function setData($data){
$this->data = $data;
@ -79,6 +83,7 @@ class JSONResponse extends Response {
/**
* Used to get the set parameters
* @return array the data
* @since 6.0.0
*/
public function getData(){
return $this->data;

5
lib/public/appframework/http/notfoundresponse.php
Unescape Escape View File

@ -26,15 +26,20 @@ use OCP\Template;
/**
* A generic 404 response showing an 404 error page as well to the end-user
* @since 8.1.0
*/
class NotFoundResponse extends Response {
/**
* @since 8.1.0
*/
public function __construct() {
$this->setStatus(404);
}
/**
* @return string
* @since 8.1.0
*/
public function render() {
$template = new Template('core', '404', 'guest');

9
lib/public/appframework/http/ocsresponse.php
Unescape Escape View File

@ -33,6 +33,7 @@ use OC_OCS;
/**
* A renderer for OCS responses
* @since 8.1.0
*/
class OCSResponse extends Response {
@ -58,6 +59,7 @@ class OCSResponse extends Response {
* @param int $dimension
* @param int|string $itemscount
* @param int|string $itemsperpage
* @since 8.1.0
*/
public function __construct($format, $status, $statuscode, $message,
$data=[], $tag='', $tagattribute='',
@ -86,7 +88,10 @@ class OCSResponse extends Response {
}
}
/**
* @return string
* @since 8.1.0
*/
public function render() {
return OC_OCS::generateXml(
$this->format, $this->status, $this->statuscode, $this->message,
@ -96,4 +101,4 @@ class OCSResponse extends Response {
}
}
}

3
lib/public/appframework/http/redirectresponse.php
Unescape Escape View File

@ -31,6 +31,7 @@ use OCP\AppFramework\Http;
/**
* Redirects to a different URL
* @since 7.0.0
*/
class RedirectResponse extends Response {
@ -39,6 +40,7 @@ class RedirectResponse extends Response {
/**
* Creates a response that redirects to a url
* @param string $redirectURL the url to redirect to
* @since 7.0.0
*/
public function __construct($redirectURL) {
$this->redirectURL = $redirectURL;
@ -49,6 +51,7 @@ class RedirectResponse extends Response {
/**
* @return string the url to redirect
* @since 7.0.0
*/
public function getRedirectURL() {
return $this->redirectURL;

27
lib/public/appframework/http/response.php
Unescape Escape View File

@ -37,6 +37,7 @@ use OCP\AppFramework\Http;
* Base class for responses. Also used to just send headers.
*
* It handles headers, HTTP status code, last modified and ETag.
* @since 6.0.0
*/
class Response {
@ -85,6 +86,7 @@ class Response {
* @param int $cacheSeconds the amount of seconds that should be cached
* if 0 then caching will be disabled
* @return $this
* @since 6.0.0 - return value was added in 7.0.0
*/
public function cacheFor($cacheSeconds) {
@ -106,6 +108,7 @@ class Response {
* to null cookie will be considered as session
* cookie.
* @return $this
* @since 8.0.0
*/
public function addCookie($name, $value, \DateTime $expireDate = null) {
$this->cookies[$name] = array('value' => $value, 'expireDate' => $expireDate);
@ -117,6 +120,7 @@ class Response {
* Set the specified cookies
* @param array $cookies array('foo' => array('value' => 'bar', 'expire' => null))
* @return $this
* @since 8.0.0
*/
public function setCookies(array $cookies) {
$this->cookies = $cookies;
@ -128,6 +132,7 @@ class Response {
* Invalidates the specified cookie
* @param string $name
* @return $this
* @since 8.0.0
*/
public function invalidateCookie($name) {
$this->addCookie($name, 'expired', new \DateTime('1971-01-01 00:00'));
@ -138,6 +143,7 @@ class Response {
* Invalidates the specified cookies
* @param array $cookieNames array('foo', 'bar')
* @return $this
* @since 8.0.0
*/
public function invalidateCookies(array $cookieNames) {
foreach($cookieNames as $cookieName) {
@ -149,6 +155,7 @@ class Response {
/**
* Returns the cookies
* @return array
* @since 8.0.0
*/
public function getCookies() {
return $this->cookies;
@ -160,6 +167,7 @@ class Response {
* @param string $name The name of the HTTP header
* @param string $value The value, null will delete it
* @return $this
* @since 6.0.0 - return value was added in 7.0.0
*/
public function addHeader($name, $value) {
$name = trim($name); // always remove leading and trailing whitespace
@ -180,6 +188,7 @@ class Response {
* Set the headers
* @param array $headers value header pairs
* @return $this
* @since 8.0.0
*/
public function setHeaders(array $headers) {
$this->headers = $headers;
@ -191,6 +200,7 @@ class Response {
/**
* Returns the set headers
* @return array the headers
* @since 6.0.0
*/
public function getHeaders() {
$mergeWith = [];
@ -217,6 +227,7 @@ class Response {
/**
* By default renders no output
* @return null
* @since 6.0.0
*/
public function render() {
return null;
@ -224,10 +235,11 @@ class Response {
/**
* Set response status
* @param int $status a HTTP status code, see also the STATUS constants
* @return Response Reference to this object
*/
* Set response status
* @param int $status a HTTP status code, see also the STATUS constants
* @return Response Reference to this object
* @since 6.0.0 - return value was added in 7.0.0
*/
public function setStatus($status) {
$this->status = $status;
@ -238,6 +250,7 @@ class Response {
* Set a Content-Security-Policy
* @param ContentSecurityPolicy $csp Policy to set for the response object
* @return $this
* @since 8.1.0
*/
public function setContentSecurityPolicy(ContentSecurityPolicy $csp) {
$this->contentSecurityPolicy = $csp;
@ -248,6 +261,7 @@ class Response {
* Get the currently used Content-Security-Policy
* @return ContentSecurityPolicy|null Used Content-Security-Policy or null if
* none specified.
* @since 8.1.0
*/
public function getContentSecurityPolicy() {
return $this->contentSecurityPolicy;
@ -256,6 +270,7 @@ class Response {
/**
* Get response status
* @since 6.0.0
*/
public function getStatus() {
return $this->status;
@ -265,6 +280,7 @@ class Response {
/**
* Get the ETag
* @return string the etag
* @since 6.0.0
*/
public function getETag() {
return $this->ETag;
@ -274,6 +290,7 @@ class Response {
/**
* Get "last modified" date
* @return \DateTime RFC2822 formatted last modified date
* @since 6.0.0
*/
public function getLastModified() {
return $this->lastModified;
@ -284,6 +301,7 @@ class Response {
* Set the ETag
* @param string $ETag
* @return Response Reference to this object
* @since 6.0.0 - return value was added in 7.0.0
*/
public function setETag($ETag) {
$this->ETag = $ETag;
@ -296,6 +314,7 @@ class Response {
* Set "last modified" date
* @param \DateTime $lastModified
* @return Response Reference to this object
* @since 6.0.0 - return value was added in 7.0.0
*/
public function setLastModified($lastModified) {
$this->lastModified = $lastModified;

3
lib/public/appframework/http/streamresponse.php
Unescape Escape View File

@ -28,6 +28,7 @@ use OCP\AppFramework\Http;
* Class StreamResponse
*
* @package OCP\AppFramework\Http
* @since 8.1.0
*/
class StreamResponse extends Response implements ICallbackResponse {
/** @var string */
@ -35,6 +36,7 @@ class StreamResponse extends Response implements ICallbackResponse {
/**
* @param string $filePath the path to the file which should be streamed
* @since 8.1.0
*/
public function __construct ($filePath) {
$this->filePath = $filePath;
@ -45,6 +47,7 @@ class StreamResponse extends Response implements ICallbackResponse {
* Streams the file using readfile
*
* @param IOutput $output a small wrapper that handles output
* @since 8.1.0
*/
public function callback (IOutput $output) {
// handle caching

8
lib/public/appframework/http/templateresponse.php
Unescape Escape View File

@ -32,6 +32,7 @@ namespace OCP\AppFramework\Http;
/**
* Response for a normal template
* @since 6.0.0
*/
class TemplateResponse extends Response {
@ -66,6 +67,7 @@ class TemplateResponse extends Response {
* @param array $params an array of parameters which should be passed to the
* template
* @param string $renderAs how the page should be rendered, defaults to user
* @since 6.0.0 - parameters $params and $renderAs were added in 7.0.0
*/
public function __construct($appName, $templateName, array $params=array(),
$renderAs='user') {
@ -81,6 +83,7 @@ class TemplateResponse extends Response {
* @param array $params an array with key => value structure which sets template
* variables
* @return TemplateResponse Reference to this object
* @since 6.0.0 - return value was added in 7.0.0
*/
public function setParams(array $params){
$this->params = $params;
@ -92,6 +95,7 @@ class TemplateResponse extends Response {
/**
* Used for accessing the set parameters
* @return array the params
* @since 6.0.0
*/
public function getParams(){
return $this->params;
@ -101,6 +105,7 @@ class TemplateResponse extends Response {
/**
* Used for accessing the name of the set template
* @return string the name of the used template
* @since 6.0.0
*/
public function getTemplateName(){
return $this->templateName;
@ -114,6 +119,7 @@ class TemplateResponse extends Response {
* normal page including footer and header and blank
* just renders the plain template
* @return TemplateResponse Reference to this object
* @since 6.0.0 - return value was added in 7.0.0
*/
public function renderAs($renderAs){
$this->renderAs = $renderAs;
@ -125,6 +131,7 @@ class TemplateResponse extends Response {
/**
* Returns the set renderAs
* @return string the renderAs value
* @since 6.0.0
*/
public function getRenderAs(){
return $this->renderAs;
@ -134,6 +141,7 @@ class TemplateResponse extends Response {
/**
* Returns the rendered html
* @return string the rendered html
* @since 6.0.0
*/
public function render(){
// \OCP\Template needs an empty string instead of 'blank' for an unwrapped response

8
lib/public/appframework/iappcontainer.php
Unescape Escape View File

@ -32,35 +32,41 @@ use OCP\IContainer;
* @package OCP\AppFramework
*
* This container interface provides short cuts for app developers to access predefined app service.
* @since 6.0.0
*/
interface IAppContainer extends IContainer {
/**
* used to return the appname of the set application
* @return string the name of your application
* @since 6.0.0
*/
function getAppName();
/**
* @deprecated implements only deprecated methods
* @return IApi
* @since 6.0.0
*/
function getCoreApi();
/**
* @return \OCP\IServerContainer
* @since 6.0.0
*/
function getServer();
/**
* @param string $middleWare
* @return boolean
* @since 6.0.0
*/
function registerMiddleWare($middleWare);
/**
* @deprecated use IUserSession->isLoggedIn()
* @return boolean
* @since 6.0.0
*/
function isLoggedIn();
@ -69,6 +75,7 @@ interface IAppContainer extends IContainer {
* @return boolean
* @deprecated use the groupmanager instead to find out if the user is in
* the admin group
* @since 6.0.0
*/
function isAdminUser();
@ -77,6 +84,7 @@ interface IAppContainer extends IContainer {
* @param string $message
* @param string $level
* @return mixed
* @since 6.0.0
*/
function log($message, $level);

5
lib/public/appframework/middleware.php
Unescape Escape View File

@ -37,6 +37,7 @@ use OCP\AppFramework\Http\Response;
* deal with possible exceptions raised in the controller methods.
* They're modeled after Django's middleware system:
* https://docs.djangoproject.com/en/dev/topics/http/middleware/
* @since 6.0.0
*/
abstract class Middleware {
@ -48,6 +49,7 @@ abstract class Middleware {
* @param Controller $controller the controller that is being called
* @param string $methodName the name of the method that will be called on
* the controller
* @since 6.0.0
*/
public function beforeController($controller, $methodName){
@ -67,6 +69,7 @@ abstract class Middleware {
* @param \Exception $exception the thrown exception
* @throws \Exception the passed in exception if it cant handle it
* @return Response a Response object in case that the exception was handled
* @since 6.0.0
*/
public function afterException($controller, $methodName, \Exception $exception){
throw $exception;
@ -82,6 +85,7 @@ abstract class Middleware {
* the controller
* @param Response $response the generated response from the controller
* @return Response a Response object
* @since 6.0.0
*/
public function afterController($controller, $methodName, Response $response){
return $response;
@ -97,6 +101,7 @@ abstract class Middleware {
* the controller
* @param string $output the generated output from a response
* @return string the output that should be printed
* @since 6.0.0
*/
public function beforeOutput($controller, $methodName, $output){
return $output;

3
lib/public/appframework/ocscontroller.php
Unescape Escape View File

@ -34,6 +34,7 @@ use OCP\IRequest;
/**
* Base class to inherit your controllers from that are used for RESTful APIs
* @since 8.1.0
*/
abstract class OCSController extends ApiController {
@ -49,6 +50,7 @@ abstract class OCSController extends ApiController {
* defaults to 'Authorization, Content-Type, Accept'
* @param int $corsMaxAge number in seconds how long a preflighted OPTIONS
* request should be cached, defaults to 1728000 seconds
* @since 8.1.0
*/
public function __construct($appName,
IRequest $request,
@ -70,6 +72,7 @@ abstract class OCSController extends ApiController {
* Unwrap data and build ocs response
* @param string $format json or xml
* @param array|DataResponse $data the data which should be transformed
* @since 8.1.0
*/
private function buildOCSResponse($format, $data) {
if ($data instanceof DataResponse) {

7
lib/public/appframework/queryexception.php
Unescape Escape View File

@ -24,5 +24,10 @@ namespace OCP\AppFramework;
use Exception;
/**
* Class QueryException
*
* @package OCP\AppFramework
* @since 8.1.0
*/
class QueryException extends Exception {}

7
lib/public/appframework/utility/icontrollermethodreflector.php
Unescape Escape View File

@ -28,12 +28,14 @@ namespace OCP\AppFramework\Utility;
* Reads and parses annotations from doc comments
*
* @package OCP\AppFramework\Utility
* @since 8.0.0
*/
interface IControllerMethodReflector {
/**
* @param object $object an object or classname
* @param string $method the method which we want to inspect
* @since 8.0.0
*/
public function reflect($object, $method);
@ -44,11 +46,13 @@ interface IControllerMethodReflector {
* parsed
* @return string|null type in the type parameters (@param int $something)
* would return int or null if not existing
* @since 8.0.0
*/
public function getType($parameter);
/**
* @return array the arguments of the method with key => default value
* @since 8.0.0
*/
public function getParameters();
@ -57,7 +61,8 @@ interface IControllerMethodReflector {
*
* @param string $name the name of the annotation
* @return bool true if the annotation is found
* @since 8.0.0
*/
public function hasAnnotation($name);
}
}

2
lib/public/appframework/utility/itimefactory.php
Unescape Escape View File

@ -26,11 +26,13 @@ namespace OCP\AppFramework\Utility;
/**
* Needed to mock calls to time()
* @since 8.0.0
*/
interface ITimeFactory {
/**
* @return int the result of a call to time()
* @since 8.0.0
*/
public function getTime();

9
lib/public/authentication/iapachebackend.php
Unescape Escape View File

@ -29,12 +29,19 @@
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP\Authentication;
/**
* Interface IApacheBackend
*
* @package OCP\Authentication
* @since 6.0.0
*/
interface IApacheBackend {
/**
* In case the user has been authenticated by Apache true is returned.
*
* @return boolean whether Apache reports a user as currently logged in.
* @since 6.0.0
*/
public function isSessionActive();
@ -43,12 +50,14 @@ interface IApacheBackend {
* supply any attribute(s) which are valid for <a>.
*
* @return string with one or more HTML attributes.
* @since 6.0.0
*/
public function getLogoutAttribute();
/**
* Return the id of the current user
* @return string
* @since 6.0.0
*/
public function getCurrentUserId();

11
lib/public/backgroundjob.php
Unescape Escape View File

@ -47,6 +47,7 @@ use \OC\BackgroundJob\JobList;
* A regular Job will be executed every time cron.php is run, a QueuedJob will only run once and a TimedJob
* will only run at a specific interval which is to be specified in the constructor of the job by calling
* $this->setInterval($interval) with $interval in seconds.
* @since 4.5.0
*/
class BackgroundJob {
/**
@ -56,6 +57,7 @@ class BackgroundJob {
*
* This method returns the type how background jobs are executed. If the user
* did not select something, the type is ajax.
* @since 5.0.0
*/
public static function getExecutionType() {
return \OC_BackgroundJob::getExecutionType();
@ -69,6 +71,7 @@ class BackgroundJob {
*
* This method sets the execution type of the background jobs. Possible types
* are "none", "ajax", "webcron", "cron"
* @since 5.0.0
*/
public static function setExecutionType($type) {
return \OC_BackgroundJob::setExecutionType($type);
@ -77,6 +80,7 @@ class BackgroundJob {
/**
* @param string $job
* @param mixed $argument
* @since 6.0.0
*/
public static function registerJob($job, $argument = null) {
$jobList = \OC::$server->getJobList();
@ -89,6 +93,7 @@ class BackgroundJob {
* @param string $klass class name
* @param string $method method name
* @return boolean|null
* @since 4.5.0
*/
public static function addRegularTask($klass, $method) {
if (!\OC::needUpgrade()) {
@ -103,6 +108,7 @@ class BackgroundJob {
* @return array
*
* key is string "$klass-$method", value is array( $klass, $method )
* @since 4.5.0
*/
static public function allRegularTasks() {
$jobList = \OC::$server->getJobList();
@ -122,6 +128,7 @@ class BackgroundJob {
* Gets one queued task
* @param int $id ID of the task
* @return BackgroundJob\IJob|null
* @since 4.5.0
*/
public static function findQueuedTask($id) {
$jobList = \OC::$server->getJobList();
@ -132,6 +139,7 @@ class BackgroundJob {
* @deprecated
* Gets all queued tasks
* @return array an array of associative arrays
* @since 4.5.0
*/
public static function allQueuedTasks() {
$jobList = \OC::$server->getJobList();
@ -152,6 +160,7 @@ class BackgroundJob {
* Gets all queued tasks of a specific app
* @param string $app app name
* @return array an array of associative arrays
* @since 4.5.0
*/
public static function queuedTaskWhereAppIs($app) {
$jobList = \OC::$server->getJobList();
@ -177,6 +186,7 @@ class BackgroundJob {
* @param string $method method name
* @param string $parameters all useful data as text
* @return boolean id of task
* @since 4.5.0
*/
public static function addQueuedTask($app, $class, $method, $parameters) {
self::registerJob('OC\BackgroundJob\Legacy\QueuedJob', array('app' => $app, 'klass' => $class, 'method' => $method, 'parameters' => $parameters));
@ -190,6 +200,7 @@ class BackgroundJob {
* @return boolean|null
*
* Deletes a report
* @since 4.5.0
*/
public static function deleteQueuedTask($id) {
$jobList = \OC::$server->getJobList();

10
lib/public/backgroundjob/ijob.php
Unescape Escape View File

@ -23,6 +23,12 @@
namespace OCP\BackgroundJob;
/**
* Interface IJob
*
* @package OCP\BackgroundJob
* @since 7.0.0
*/
interface IJob {
/**
* Run the background job with the registered argument
@ -30,6 +36,7 @@ interface IJob {
* @param \OCP\BackgroundJob\IJobList $jobList The job list that manages the state of this job
* @param \OC\Log $logger
* @return void
* @since 7.0.0
*/
public function execute($jobList, $logger = null);
@ -38,6 +45,7 @@ interface IJob {
* This id is determined by the job list when a job is added to the list
*
* @return int
* @since 7.0.0
*/
public function getId();
@ -45,6 +53,7 @@ interface IJob {
* Get the last time this job was run as unix timestamp
*
* @return int
* @since 7.0.0
*/
public function getLastRun();
@ -53,6 +62,7 @@ interface IJob {
* This is the argument that will be passed to the background job
*
* @return mixed
* @since 7.0.0
*/
public function getArgument();
}

15
lib/public/backgroundjob/ijoblist.php
Unescape Escape View File

@ -24,6 +24,12 @@
namespace OCP\BackgroundJob;
/**
* Interface IJobList
*
* @package OCP\BackgroundJob
* @since 7.0.0
*/
interface IJobList {
/**
* Add a job to the list
@ -32,6 +38,7 @@ interface IJobList {
* @param mixed $argument The argument to be passed to $job->run() when the job is exectured
* @param string $job
* @return void
* @since 7.0.0
*/
public function add($job, $argument = null);
@ -41,6 +48,7 @@ interface IJobList {
* @param \OCP\BackgroundJob\IJob|string $job
* @param mixed $argument
* @return void
* @since 7.0.0
*/
public function remove($job, $argument = null);
@ -50,6 +58,7 @@ interface IJobList {
* @param \OCP\BackgroundJob\IJob|string $job
* @param mixed $argument
* @return bool
* @since 7.0.0
*/
public function has($job, $argument);
@ -57,6 +66,7 @@ interface IJobList {
* get all jobs in the list
*
* @return \OCP\BackgroundJob\IJob[]
* @since 7.0.0
*/
public function getAll();
@ -64,12 +74,14 @@ interface IJobList {
* get the next job in the list
*
* @return \OCP\BackgroundJob\IJob
* @since 7.0.0
*/
public function getNext();
/**
* @param int $id
* @return \OCP\BackgroundJob\IJob
* @since 7.0.0
*/
public function getById($id);
@ -78,6 +90,7 @@ interface IJobList {
*
* @param \OCP\BackgroundJob\IJob $job
* @return void
* @since 7.0.0
*/
public function setLastJob($job);
@ -85,6 +98,7 @@ interface IJobList {
* get the id of the last ran job
*
* @return int
* @since 7.0.0
*/
public function getLastJob();
@ -93,6 +107,7 @@ interface IJobList {
*
* @param \OCP\BackgroundJob\IJob $job
* @return void
* @since 7.0.0
*/
public function setLastRun($job);
}

8
lib/public/command/ibus.php
Unescape Escape View File

@ -21,11 +21,18 @@
namespace OCP\Command;
/**
* Interface IBus
*
* @package OCP\Command
* @since 8.1.0
*/
interface IBus {
/**
* Schedule a command to be fired
*
* @param \OCP\Command\ICommand | callable $command
* @since 8.1.0
*/
public function push($command);
@ -33,6 +40,7 @@ interface IBus {
* Require all commands using a trait to be run synchronous
*
* @param string $trait
* @since 8.1.0
*/
public function requireSync($trait);
}

7
lib/public/command/icommand.php
Unescape Escape View File

@ -21,9 +21,16 @@
namespace OCP\Command;
/**
* Interface ICommand
*
* @package OCP\Command
* @since 8.1.0
*/
interface ICommand {
/**
* Run the command
* @since 8.1.0
*/
public function handle();
}

6
lib/public/constants.php
Unescape Escape View File

@ -49,6 +49,12 @@ const PERMISSION_ALL = 31;
/** @deprecated Use \OCP\Constants::FILENAME_INVALID_CHARS instead */
const FILENAME_INVALID_CHARS = "\\/<>:\"|?*\n";
/**
* Class Constants
*
* @package OCP
* @since 8.0.0
*/
class Constants {
/**
* CRUDS permissions.

9
lib/public/contacts.php
Unescape Escape View File

@ -46,6 +46,7 @@ namespace OCP {
* For updating it is mandatory to keep the id.
* Without an id a new contact will be created.
*
* @since 5.0.0
*/
class Contacts {
@ -90,6 +91,7 @@ namespace OCP {
* @param array $searchProperties defines the properties within the query pattern should match
* @param array $options - for future use. One should always have options!
* @return array an array of contacts which are arrays of key-value-pairs
* @since 5.0.0
*/
public static function search($pattern, $searchProperties = array(), $options = array()) {
$cm = \OC::$server->getContactsManager();
@ -102,6 +104,7 @@ namespace OCP {
* @param object $id the unique identifier to a contact
* @param string $address_book_key
* @return bool successful or not
* @since 5.0.0
*/
public static function delete($id, $address_book_key) {
$cm = \OC::$server->getContactsManager();
@ -115,6 +118,7 @@ namespace OCP {
* @param array $properties this array if key-value-pairs defines a contact
* @param string $address_book_key identifier of the address book in which the contact shall be created or updated
* @return array an array representing the contact just created or updated
* @since 5.0.0
*/
public static function createOrUpdate($properties, $address_book_key) {
$cm = \OC::$server->getContactsManager();
@ -125,6 +129,7 @@ namespace OCP {
* Check if contacts are available (e.g. contacts app enabled)
*
* @return bool true if enabled, false if not
* @since 5.0.0
*/
public static function isEnabled() {
$cm = \OC::$server->getContactsManager();
@ -133,6 +138,7 @@ namespace OCP {
/**
* @param \OCP\IAddressBook $address_book
* @since 5.0.0
*/
public static function registerAddressBook(\OCP\IAddressBook $address_book) {
$cm = \OC::$server->getContactsManager();
@ -141,6 +147,7 @@ namespace OCP {
/**
* @param \OCP\IAddressBook $address_book
* @since 5.0.0
*/
public static function unregisterAddressBook(\OCP\IAddressBook $address_book) {
$cm = \OC::$server->getContactsManager();
@ -149,6 +156,7 @@ namespace OCP {
/**
* @return array
* @since 5.0.0
*/
public static function getAddressBooks() {
$cm = \OC::$server->getContactsManager();
@ -157,6 +165,7 @@ namespace OCP {
/**
* removes all registered address book instances
* @since 5.0.0
*/
public static function clear() {
$cm = \OC::$server->getContactsManager();

10
lib/public/contacts/imanager.php
Unescape Escape View File

@ -47,6 +47,7 @@ namespace OCP\Contacts {
* For updating it is mandatory to keep the id.
* Without an id a new contact will be created.
*
* @since 6.0.0
*/
interface IManager {
@ -92,6 +93,7 @@ namespace OCP\Contacts {
* @param array $searchProperties defines the properties within the query pattern should match
* @param array $options - for future use. One should always have options!
* @return array an array of contacts which are arrays of key-value-pairs
* @since 6.0.0
*/
function search($pattern, $searchProperties = array(), $options = array());
@ -101,6 +103,7 @@ namespace OCP\Contacts {
* @param object $id the unique identifier to a contact
* @param string $address_book_key identifier of the address book in which the contact shall be deleted
* @return bool successful or not
* @since 6.0.0
*/
function delete($id, $address_book_key);
@ -111,6 +114,7 @@ namespace OCP\Contacts {
* @param array $properties this array if key-value-pairs defines a contact
* @param string $address_book_key identifier of the address book in which the contact shall be created or updated
* @return array an array representing the contact just created or updated
* @since 6.0.0
*/
function createOrUpdate($properties, $address_book_key);
@ -118,6 +122,7 @@ namespace OCP\Contacts {
* Check if contacts are available (e.g. contacts app enabled)
*
* @return bool true if enabled, false if not
* @since 6.0.0
*/
function isEnabled();
@ -126,6 +131,7 @@ namespace OCP\Contacts {
*
* @param \OCP\IAddressBook $address_book
* @return void
* @since 6.0.0
*/
function registerAddressBook(\OCP\IAddressBook $address_book);
@ -134,6 +140,7 @@ namespace OCP\Contacts {
*
* @param \OCP\IAddressBook $address_book
* @return void
* @since 6.0.0
*/
function unregisterAddressBook(\OCP\IAddressBook $address_book);
@ -143,17 +150,20 @@ namespace OCP\Contacts {
*
* @param \Closure $callable
* @return void
* @since 6.0.0
*/
function register(\Closure $callable);
/**
* @return array
* @since 6.0.0
*/
function getAddressBooks();
/**
* removes all registered address book instances
* @return void
* @since 6.0.0
*/
function clear();
}

9
lib/public/db.php
Unescape Escape View File

@ -40,6 +40,7 @@ namespace OCP;
/**
* This class provides access to the internal database system. Use this class exlusively if you want to access databases
* @since 4.5.0
*/
class DB {
/**
@ -50,6 +51,7 @@ class DB {
* @return \OC_DB_StatementWrapper prepared SQL query
*
* SQL query via Doctrine prepare(), needs to be execute()'d!
* @since 4.5.0
*/
static public function prepare( $query, $limit=null, $offset=null ) {
return(\OC_DB::prepare($query, $limit, $offset));
@ -64,6 +66,7 @@ class DB {
* If this is null or an empty array, all keys of $input will be compared
* @return int number of inserted rows
* @throws \Doctrine\DBAL\DBALException
* @since 5.0.0 - parameter $compare was added in 8.1.0
*
*/
public static function insertIfNotExist($table, $input, array $compare = null) {
@ -79,6 +82,7 @@ class DB {
*
* Call this method right after the insert command or other functions may
* cause trouble!
* @since 4.5.0
*/
public static function insertid($table=null) {
return(\OC_DB::insertid($table));
@ -86,6 +90,7 @@ class DB {
/**
* Start a transaction
* @since 4.5.0
*/
public static function beginTransaction() {
\OC_DB::beginTransaction();
@ -93,6 +98,7 @@ class DB {
/**
* Commit the database changes done during a transaction that is in progress
* @since 4.5.0
*/
public static function commit() {
\OC_DB::commit();
@ -100,6 +106,7 @@ class DB {
/**
* Rollback the database changes done during a transaction that is in progress
* @since 8.0.0
*/
public static function rollback() {
\OC_DB::rollback();
@ -109,6 +116,7 @@ class DB {
* Check if a result is an error, works with Doctrine
* @param mixed $result
* @return bool
* @since 4.5.0
*/
public static function isError($result) {
return(\OC_DB::isError($result));
@ -119,6 +127,7 @@ class DB {
* works with DoctrineException
* @param mixed $error
* @return string
* @since 6.0.0
*/
public static function getErrorMessage($error) {
return(\OC_DB::getErrorMessage($error));

15
lib/public/defaults.php
Unescape Escape View File

@ -34,12 +34,14 @@ namespace OCP;
/**
* public api to access default strings and urls for your templates
* @since 6.0.0
*/
class Defaults {
/**
* \OC_Defaults instance to retrieve the defaults
* @return string
* @since 6.0.0
*/
private $defaults;
@ -54,6 +56,7 @@ class Defaults {
/**
* get base URL for the organisation behind your ownCloud instance
* @return string
* @since 6.0.0
*/
public function getBaseUrl() {
return $this->defaults->getBaseUrl();
@ -62,6 +65,7 @@ class Defaults {
/**
* link to the desktop sync client
* @return string
* @since 6.0.0
*/
public function getSyncClientUrl() {
return $this->defaults->getSyncClientUrl();
@ -70,6 +74,7 @@ class Defaults {
/**
* link to the iOS client
* @return string
* @since 8.0.0
*/
public function getiOSClientUrl() {
return $this->defaults->getiOSClientUrl();
@ -78,6 +83,7 @@ class Defaults {
/**
* link to the Android client
* @return string
* @since 8.0.0
*/
public function getAndroidClientUrl() {
return $this->defaults->getAndroidClientUrl();
@ -86,6 +92,7 @@ class Defaults {
/**
* base URL to the documentation of your ownCloud instance
* @return string
* @since 6.0.0
*/
public function getDocBaseUrl() {
return $this->defaults->getDocBaseUrl();
@ -94,6 +101,7 @@ class Defaults {
/**
* name of your ownCloud instance
* @return string
* @since 6.0.0
*/
public function getName() {
return $this->defaults->getName();
@ -102,6 +110,7 @@ class Defaults {
/**
* name of your ownCloud instance containing HTML styles
* @return string
* @since 8.0.0
*/
public function getHTMLName() {
return $this->defaults->getHTMLName();
@ -110,6 +119,7 @@ class Defaults {
/**
* Entity behind your onwCloud instance
* @return string
* @since 6.0.0
*/
public function getEntity() {
return $this->defaults->getEntity();
@ -118,6 +128,7 @@ class Defaults {
/**
* ownCloud slogan
* @return string
* @since 6.0.0
*/
public function getSlogan() {
return $this->defaults->getSlogan();
@ -126,6 +137,7 @@ class Defaults {
/**
* logo claim
* @return string
* @since 6.0.0
*/
public function getLogoClaim() {
return $this->defaults->getLogoClaim();
@ -134,6 +146,7 @@ class Defaults {
/**
* footer, short version
* @return string
* @since 6.0.0
*/
public function getShortFooter() {
return $this->defaults->getShortFooter();
@ -142,6 +155,7 @@ class Defaults {
/**
* footer, long version
* @return string
* @since 6.0.0
*/
public function getLongFooter() {
return $this->defaults->getLongFooter();
@ -150,6 +164,7 @@ class Defaults {
/**
* Returns the AppId for the App Store for the iOS Client
* @return string AppId
* @since 8.0.0
*/
public function getiTunesAppId() {
return $this->defaults->getiTunesAppId();

11
lib/public/diagnostics/ievent.php
Unescape Escape View File

@ -22,29 +22,40 @@
namespace OCP\Diagnostics;
/**
* Interface IEvent
*
* @package OCP\Diagnostics
* @since 8.0.0
*/
interface IEvent {
/**
* @return string
* @since 8.0.0
*/
public function getId();
/**
* @return string
* @since 8.0.0
*/
public function getDescription();
/**
* @return float
* @since 8.0.0
*/
public function getStart();
/**
* @return float
* @since 8.0.0
*/
public function getEnd();
/**
* @return float
* @since 8.0.0
*/
public function getDuration();
}

10
lib/public/diagnostics/ieventlogger.php
Unescape Escape View File

@ -22,12 +22,19 @@
namespace OCP\Diagnostics;
/**
* Interface IEventLogger
*
* @package OCP\Diagnostics
* @since 8.0.0
*/
interface IEventLogger {
/**
* Mark the start of an event
*
* @param string $id
* @param string $description
* @since 8.0.0
*/
public function start($id, $description);
@ -35,6 +42,7 @@ interface IEventLogger {
* Mark the end of an event
*
* @param string $id
* @since 8.0.0
*/
public function end($id);
@ -43,11 +51,13 @@ interface IEventLogger {
* @param string $description
* @param float $start
* @param float $end
* @since 8.0.0
*/
public function log($id, $description, $start, $end);
/**
* @return \OCP\Diagnostics\IEvent[]
* @since 8.0.0
*/
public function getEvents();
}

9
lib/public/diagnostics/iquery.php
Unescape Escape View File

@ -22,19 +22,28 @@
namespace OCP\Diagnostics;
/**
* Interface IQuery
*
* @package OCP\Diagnostics
* @since 8.0.0
*/
interface IQuery {
/**
* @return string
* @since 8.0.0
*/
public function getSql();
/**
* @return array
* @since 8.0.0
*/
public function getParams();
/**
* @return float
* @since 8.0.0
*/
public function getDuration();
}

12
lib/public/diagnostics/iquerylogger.php
Unescape Escape View File

@ -24,18 +24,30 @@ namespace OCP\Diagnostics;
use Doctrine\DBAL\Logging\SQLLogger;
/**
* Interface IQueryLogger
*
* @package OCP\Diagnostics
* @since 8.0.0
*/
interface IQueryLogger extends SQLLogger {
/**
* @param string $sql
* @param array $params
* @param array $types
* @since 8.0.0
*/
public function startQuery($sql, array $params = null, array $types = null);
/**
* @return mixed
* @since 8.0.0
*/
public function stopQuery();
/**
* @return \OCP\Diagnostics\IQuery[]
* @since 8.0.0
*/
public function getQueries();
}

8
lib/public/encryption/exceptions/genericencryptionexception.php
Unescape Escape View File

@ -22,13 +22,19 @@
namespace OCP\Encryption\Exceptions;
/**
* Class GenericEncryptionException
*
* @package OCP\Encryption\Exceptions
* @since 8.1.0
*/
class GenericEncryptionException extends \Exception {
/**
* @param string $message
* @param int $code
* @param \Exception $previous
* @since 8.1.0
*/
public function __construct($message = '', $code = 0, \Exception $previous = null) {
if (empty($message)) {

15
lib/public/encryption/iencryptionmodule.php
Unescape Escape View File

@ -21,10 +21,17 @@
namespace OCP\Encryption;
/**
* Interface IEncryptionModule
*
* @package OCP\Encryption
* @since 8.1.0
*/
interface IEncryptionModule {
/**
* @return string defining the technical unique id
* @since 8.1.0
*/
public function getId();
@ -32,6 +39,7 @@ interface IEncryptionModule {
* In comparison to getKey() this function returns a human readable (maybe translated) name
*
* @return string
* @since 8.1.0
*/
public function getDisplayName();
@ -48,6 +56,7 @@ interface IEncryptionModule {
* $return array $header contain data as key-value pairs which should be
* written to the header, in case of a write operation
* or if no additional data is needed return a empty array
* @since 8.1.0
*/
public function begin($path, $user, array $header, array $accessList);
@ -59,6 +68,7 @@ interface IEncryptionModule {
* @param string $path to the file
* @return string remained data which should be written to the file in case
* of a write operation
* @since 8.1.0
*/
public function end($path);
@ -67,6 +77,7 @@ interface IEncryptionModule {
*
* @param string $data you want to encrypt
* @return mixed encrypted data
* @since 8.1.0
*/
public function encrypt($data);
@ -75,6 +86,7 @@ interface IEncryptionModule {
*
* @param string $data you want to decrypt
* @return mixed decrypted data
* @since 8.1.0
*/
public function decrypt($data);
@ -85,6 +97,7 @@ interface IEncryptionModule {
* @param string $uid of the user who performs the operation
* @param array $accessList who has access to the file contains the key 'users' and 'public'
* @return boolean
* @since 8.1.0
*/
public function update($path, $uid, array $accessList);
@ -93,6 +106,7 @@ interface IEncryptionModule {
*
* @param string $path
* @return boolean
* @since 8.1.0
*/
public function shouldEncrypt($path);
@ -101,6 +115,7 @@ interface IEncryptionModule {
* ownCloud read/write files with a block size of 8192 byte
*
* @return integer
* @since 8.1.0
*/
public function getUnencryptedBlockSize();
}

7
lib/public/encryption/ifile.php
Unescape Escape View File

@ -22,6 +22,12 @@
namespace OCP\Encryption;
/**
* Interface IFile
*
* @package OCP\Encryption
* @since 8.1.0
*/
interface IFile {
/**
@ -29,6 +35,7 @@ interface IFile {
*
* @param string $path to the file
* @return array
* @since 8.1.0
*/
public function getAccessList($path);

8
lib/public/encryption/imanager.php
Unescape Escape View File

@ -27,6 +27,7 @@ use OC\Encryption\Exceptions\ModuleAlreadyExistsException;
/**
* This class provides access to files encryption apps.
*
* @since 8.1.0
*/
interface IManager {
@ -34,6 +35,7 @@ interface IManager {
* Check if encryption is available (at least one encryption module needs to be enabled)
*
* @return bool true if enabled, false if not
* @since 8.1.0
*/
function isEnabled();
@ -42,6 +44,7 @@ interface IManager {
*
* @param IEncryptionModule $module
* @throws ModuleAlreadyExistsException
* @since 8.1.0
*/
function registerEncryptionModule(IEncryptionModule $module);
@ -49,6 +52,7 @@ interface IManager {
* Unregisters an encryption module
*
* @param IEncryptionModule $module
* @since 8.1.0
*/
function unregisterEncryptionModule(IEncryptionModule $module);
@ -56,6 +60,7 @@ interface IManager {
* get a list of all encryption modules
*
* @return array
* @since 8.1.0
*/
function getEncryptionModules();
@ -66,6 +71,7 @@ interface IManager {
* @param string $moduleId
* @return IEncryptionModule
* @throws ModuleDoesNotExistsException
* @since 8.1.0
*/
function getEncryptionModule($moduleId);
@ -74,6 +80,7 @@ interface IManager {
*
* @return \OCP\Encryption\IEncryptionModule
* @throws ModuleDoesNotExistsException
* @since 8.1.0
*/
public function getDefaultEncryptionModule();
@ -82,6 +89,7 @@ interface IManager {
*
* @param string $moduleId
* @return string
* @since 8.1.0
*/
public function setDefaultEncryptionModule($moduleId);

18
lib/public/encryption/keys/istorage.php
Unescape Escape View File

@ -22,6 +22,12 @@
namespace OCP\Encryption\Keys;
/**
* Interface IStorage
*
* @package OCP\Encryption\Keys
* @since 8.1.0
*/
interface IStorage {
/**
@ -31,6 +37,7 @@ interface IStorage {
* @param string $keyId id of the key
*
* @return mixed key
* @since 8.1.0
*/
public function getUserKey($uid, $keyId);
@ -41,6 +48,7 @@ interface IStorage {
* @param string $keyId id of the key
*
* @return mixed key
* @since 8.1.0
*/
public function getFileKey($path, $keyId);
@ -51,6 +59,7 @@ interface IStorage {
* @param string $keyId id of the key
*
* @return mixed key
* @since 8.1.0
*/
public function getSystemUserKey($keyId);
@ -60,6 +69,7 @@ interface IStorage {
* @param string $uid ID if the user for whom we want the key
* @param string $keyId id of the key
* @param mixed $key
* @since 8.1.0
*/
public function setUserKey($uid, $keyId, $key);
@ -69,6 +79,7 @@ interface IStorage {
* @param string $path path to file
* @param string $keyId id of the key
* @param boolean
* @since 8.1.0
*/
public function setFileKey($path, $keyId, $key);
@ -80,6 +91,7 @@ interface IStorage {
* @param mixed $key
*
* @return mixed key
* @since 8.1.0
*/
public function setSystemUserKey($keyId, $key);
@ -90,6 +102,7 @@ interface IStorage {
* @param string $keyId id of the key
*
* @return boolean False when the key could not be deleted
* @since 8.1.0
*/
public function deleteUserKey($uid, $keyId);
@ -100,6 +113,7 @@ interface IStorage {
* @param string $keyId id of the key
*
* @return boolean False when the key could not be deleted
* @since 8.1.0
*/
public function deleteFileKey($path, $keyId);
@ -108,6 +122,7 @@ interface IStorage {
*
* @param string $path to the file
* @return boolean False when the keys could not be deleted
* @since 8.1.0
*/
public function deleteAllFileKeys($path);
@ -118,6 +133,7 @@ interface IStorage {
* @param string $keyId id of the key
*
* @return boolean False when the key could not be deleted
* @since 8.1.0
*/
public function deleteSystemUserKey($keyId);
@ -126,6 +142,7 @@ interface IStorage {
*
* @param string $source
* @param string $target
* @since 8.1.0
*/
public function renameKeys($source, $target);
@ -134,6 +151,7 @@ interface IStorage {
*
* @param string $source
* @param string $target
* @since 8.1.0
*/
public function copyKeys($source, $target);

9
lib/public/files.php
Unescape Escape View File

@ -40,11 +40,13 @@ namespace OCP;
/**
* This class provides access to the internal filesystem abstraction layer. Use
* this class exlusively if you want to access files
* @since 5.0.0
*/
class Files {
/**
* Recusive deletion of folders
* @return bool
* @since 5.0.0
*/
static function rmdirr( $dir ) {
return \OC_Helper::rmdirr( $dir );
@ -55,6 +57,7 @@ class Files {
* @param string $path
* @return string
* does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead
* @since 5.0.0
*/
static function getMimeType( $path ) {
return(\OC_Helper::getMimeType( $path ));
@ -64,6 +67,7 @@ class Files {
* Search for files by mimetype
* @param string $mimetype
* @return array
* @since 6.0.0
*/
static public function searchByMime( $mimetype ) {
return(\OC\Files\Filesystem::searchByMime( $mimetype ));
@ -74,6 +78,7 @@ class Files {
* @param resource $source
* @param resource $target
* @return int the number of bytes copied
* @since 5.0.0
*/
public static function streamCopy( $source, $target ) {
list($count, $result) = \OC_Helper::streamCopy( $source, $target );
@ -86,6 +91,7 @@ class Files {
* @return string
*
* temporary files are automatically cleaned up after the script is finished
* @since 5.0.0
*/
public static function tmpFile( $postfix='' ) {
return(\OC_Helper::tmpFile( $postfix ));
@ -96,6 +102,7 @@ class Files {
* @return string
*
* temporary files are automatically cleaned up after the script is finished
* @since 5.0.0
*/
public static function tmpFolder() {
return(\OC_Helper::tmpFolder());
@ -106,6 +113,7 @@ class Files {
* @param string $path
* @param string $filename
* @return string
* @since 5.0.0
*/
public static function buildNotExistingFileName( $path, $filename ) {
return(\OC_Helper::buildNotExistingFileName( $path, $filename ));
@ -116,6 +124,7 @@ class Files {
* existant
* @param string $app
* @return \OC\Files\View
* @since 5.0.0
*/
public static function getStorage( $app ) {
return \OC_App::getStorage( $app );

1
lib/public/files/alreadyexistsexception.php
Unescape Escape View File

@ -31,5 +31,6 @@ namespace OCP\Files;
/**
* Exception for already existing files/folders
* @since 6.0.0
*/
class AlreadyExistsException extends \Exception {}

2
lib/public/files/config/imountprovider.php
Unescape Escape View File

@ -27,6 +27,7 @@ use OCP\IUser;
/**
* Provides
* @since 8.0.0
*/
interface IMountProvider {
/**
@ -35,6 +36,7 @@ interface IMountProvider {
* @param \OCP\IUser $user
* @param \OCP\Files\Storage\IStorageFactory $loader
* @return \OCP\Files\Mount\IMountPoint[]
* @since 8.0.0
*/
public function getMountsForUser(IUser $user, IStorageFactory $loader);
}

3
lib/public/files/config/imountprovidercollection.php
Unescape Escape View File

@ -26,6 +26,7 @@ use OCP\IUser;
/**
* Manages the different mount providers
* @since 8.0.0
*/
interface IMountProviderCollection {
/**
@ -33,6 +34,7 @@ interface IMountProviderCollection {
*
* @param \OCP\IUser $user
* @return \OCP\Files\Mount\IMountPoint[]
* @since 8.0.0
*/
public function getMountsForUser(IUser $user);
@ -40,6 +42,7 @@ interface IMountProviderCollection {
* Add a provider for mount points
*
* @param \OCP\Files\Config\IMountProvider $provider
* @since 8.0.0
*/
public function registerProvider(IMountProvider $provider);
}

1
lib/public/files/entitytoolargeexception.php
Unescape Escape View File

@ -31,5 +31,6 @@ namespace OCP\Files;
/**
* Exception for too large entity
* @since 6.0.0
*/
class EntityTooLargeException extends \Exception {}

11
lib/public/files/file.php
Unescape Escape View File

@ -30,12 +30,19 @@
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP\Files;
/**
* Interface File
*
* @package OCP\Files
* @since 6.0.0
*/
interface File extends Node {
/**
* Get the content of the file as string
*
* @return string
* @throws \OCP\Files\NotPermittedException
* @since 6.0.0
*/
public function getContent();
@ -45,6 +52,7 @@ interface File extends Node {
* @param string $data
* @throws \OCP\Files\NotPermittedException
* @return void
* @since 6.0.0
*/
public function putContent($data);
@ -52,6 +60,7 @@ interface File extends Node {
* Get the mimetype of the file
*
* @return string
* @since 6.0.0
*/
public function getMimeType();
@ -61,6 +70,7 @@ interface File extends Node {
* @param string $mode
* @return resource
* @throws \OCP\Files\NotPermittedException
* @since 6.0.0
*/
public function fopen($mode);
@ -71,6 +81,7 @@ interface File extends Node {
* @param string $type
* @param bool $raw
* @return string
* @since 6.0.0
*/
public function hash($type, $raw = false);
}

42
lib/public/files/fileinfo.php
Unescape Escape View File

@ -24,20 +24,35 @@
*/
namespace OCP\Files;
/**
* Interface FileInfo
*
* @package OCP\Files
* @since 7.0.0
*/
interface FileInfo {
/**
* @since 7.0.0
*/
const TYPE_FILE = 'file';
/**
* @since 7.0.0
*/
const TYPE_FOLDER = 'dir';
/*
/**
* @const \OCP\Files\FileInfo::SPACE_NOT_COMPUTED Return value for a not computed space value
* @since 8.0.0
*/
const SPACE_NOT_COMPUTED = -1;
/*
/**
* @const \OCP\Files\FileInfo::SPACE_UNKNOWN Return value for unknown space value
* @since 8.0.0
*/
const SPACE_UNKNOWN = -2;
/*
/**
* @const \OCP\Files\FileInfo::SPACE_UNKNOWN Return value for unlimited space
* @since 8.0.0
*/
const SPACE_UNLIMITED = -3;
@ -45,6 +60,7 @@ interface FileInfo {
* Get the Etag of the file or folder
*
* @return string
* @since 7.0.0
*/
public function getEtag();
@ -52,6 +68,7 @@ interface FileInfo {
* Get the size in bytes for the file or folder
*
* @return int
* @since 7.0.0
*/
public function getSize();
@ -59,6 +76,7 @@ interface FileInfo {
* Get the last modified date as timestamp for the file or folder
*
* @return int
* @since 7.0.0
*/
public function getMtime();
@ -66,6 +84,7 @@ interface FileInfo {
* Get the name of the file or folder
*
* @return string
* @since 7.0.0
*/
public function getName();
@ -73,6 +92,7 @@ interface FileInfo {
* Get the path relative to the storage
*
* @return string
* @since 7.0.0
*/
public function getInternalPath();
@ -80,6 +100,7 @@ interface FileInfo {
* Get the absolute path
*
* @return string
* @since 7.0.0
*/
public function getPath();
@ -87,6 +108,7 @@ interface FileInfo {
* Get the full mimetype of the file or folder i.e. 'image/png'
*
* @return string
* @since 7.0.0
*/
public function getMimetype();
@ -94,6 +116,7 @@ interface FileInfo {
* Get the first part of the mimetype of the file or folder i.e. 'image'
*
* @return string
* @since 7.0.0
*/
public function getMimePart();
@ -101,6 +124,7 @@ interface FileInfo {
* Get the storage the file or folder is storage on
*
* @return \OCP\Files\Storage
* @since 7.0.0
*/
public function getStorage();
@ -108,6 +132,7 @@ interface FileInfo {
* Get the file id of the file or folder
*
* @return int
* @since 7.0.0
*/
public function getId();
@ -115,6 +140,7 @@ interface FileInfo {
* Check whether the file is encrypted
*
* @return bool
* @since 7.0.0
*/
public function isEncrypted();
@ -128,6 +154,7 @@ interface FileInfo {
* \OCP\Constants::PERMISSION_ALL
*
* @return int
* @since 7.0.0 - namespace of constants has changed in 8.0.0
*/
public function getPermissions();
@ -135,6 +162,7 @@ interface FileInfo {
* Check whether this is a file or a folder
*
* @return \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER
* @since 7.0.0
*/
public function getType();
@ -142,6 +170,7 @@ interface FileInfo {
* Check if the file or folder is readable
*
* @return bool
* @since 7.0.0
*/
public function isReadable();
@ -149,6 +178,7 @@ interface FileInfo {
* Check if a file is writable
*
* @return bool
* @since 7.0.0
*/
public function isUpdateable();
@ -156,6 +186,7 @@ interface FileInfo {
* Check whether new files or folders can be created inside this folder
*
* @return bool
* @since 8.0.0
*/
public function isCreatable();
@ -163,6 +194,7 @@ interface FileInfo {
* Check if a file or folder can be deleted
*
* @return bool
* @since 7.0.0
*/
public function isDeletable();
@ -170,6 +202,7 @@ interface FileInfo {
* Check if a file or folder can be shared
*
* @return bool
* @since 7.0.0
*/
public function isShareable();
@ -177,6 +210,7 @@ interface FileInfo {
* Check if a file or folder is shared
*
* @return bool
* @since 7.0.0
*/
public function isShared();
@ -184,6 +218,7 @@ interface FileInfo {
* Check if a file or folder is mounted
*
* @return bool
* @since 7.0.0
*/
public function isMounted();
@ -191,6 +226,7 @@ interface FileInfo {
* Get the mountpoint the file belongs to
*
* @return \OCP\Files\Mount\IMountPoint
* @since 8.0.0
*/
public function getMountPoint();
}

7
lib/public/files/filenametoolongexception.php
Unescape Escape View File

@ -28,6 +28,11 @@
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP\Files;
/**
* Class FileNameTooLongException
*
* @package OCP\Files
* @since 8.1.0
*/
class FileNameTooLongException extends InvalidPathException {
}

17
lib/public/files/folder.php
Unescape Escape View File

@ -30,6 +30,9 @@
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP\Files;
/**
* @since 6.0.0
*/
interface Folder extends Node {
/**
* Get the full path of an item in the folder within owncloud's filesystem
@ -37,6 +40,7 @@ interface Folder extends Node {
* @param string $path relative path of an item in the folder
* @return string
* @throws \OCP\Files\NotPermittedException
* @since 6.0.0
*/
public function getFullPath($path);
@ -46,6 +50,7 @@ interface Folder extends Node {
* @param string $path absolute path of an item in the folder
* @throws \OCP\Files\NotFoundException
* @return string
* @since 6.0.0
*/
public function getRelativePath($path);
@ -54,6 +59,7 @@ interface Folder extends Node {
*
* @param \OCP\Files\Node $node
* @return bool
* @since 6.0.0
*/
public function isSubNode($node);
@ -62,6 +68,7 @@ interface Folder extends Node {
*
* @throws \OCP\Files\NotFoundException
* @return \OCP\Files\Node[]
* @since 6.0.0
*/
public function getDirectoryListing();
@ -71,6 +78,7 @@ interface Folder extends Node {
* @param string $path relative path of the file or folder
* @return \OCP\Files\Node
* @throws \OCP\Files\NotFoundException
* @since 6.0.0
*/
public function get($path);
@ -79,6 +87,7 @@ interface Folder extends Node {
*
* @param string $path relative path of the file or folder
* @return bool
* @since 6.0.0
*/
public function nodeExists($path);
@ -88,6 +97,7 @@ interface Folder extends Node {
* @param string $path relative path of the new folder
* @return \OCP\Files\Folder
* @throws \OCP\Files\NotPermittedException
* @since 6.0.0
*/
public function newFolder($path);
@ -105,6 +115,7 @@ interface Folder extends Node {
*
* @param string $query
* @return \OCP\Files\Node[]
* @since 6.0.0
*/
public function search($query);
@ -114,6 +125,7 @@ interface Folder extends Node {
*
* @param string $mimetype
* @return \OCP\Files\Node[]
* @since 6.0.0
*/
public function searchByMime($mimetype);
@ -123,6 +135,7 @@ interface Folder extends Node {
* @param string|int $tag tag name or tag id
* @param string $userId owner of the tags
* @return \OCP\Files\Node[]
* @since 8.0.0
*/
public function searchByTag($tag, $userId);
@ -131,6 +144,7 @@ interface Folder extends Node {
*
* @param int $id
* @return \OCP\Files\Node[]
* @since 6.0.0
*/
public function getById($id);
@ -138,6 +152,7 @@ interface Folder extends Node {
* Get the amount of free space inside the folder
*
* @return int
* @since 6.0.0
*/
public function getFreeSpace();
@ -145,6 +160,7 @@ interface Folder extends Node {
* Check if new files or folders can be created within the folder
*
* @return bool
* @since 6.0.0
*/
public function isCreatable();
@ -154,6 +170,7 @@ interface Folder extends Node {
* @param string $name
* @return string
* @throws NotPermittedException
* @since 8.1.0
*/
public function getNonExistingName($name);
}

6
lib/public/files/ihomestorage.php
Unescape Escape View File

@ -29,6 +29,12 @@
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP\Files;
/**
* Interface IHomeStorage
*
* @package OCP\Files
* @since 7.0.0
*/
interface IHomeStorage {
}

1
lib/public/files/invalidcharacterinpathexception.php
Unescape Escape View File

@ -30,6 +30,7 @@ namespace OCP\Files;
/**
* Exception for invalid path
* @since 8.1.0
*/
class InvalidCharacterInPathException extends InvalidPathException {

1
lib/public/files/invalidcontentexception.php
Unescape Escape View File

@ -31,5 +31,6 @@ namespace OCP\Files;
/**
* Exception for invalid content
* @since 6.0.0
*/
class InvalidContentException extends \Exception {}

1
lib/public/files/invalidpathexception.php
Unescape Escape View File

@ -31,5 +31,6 @@ namespace OCP\Files;
/**
* Exception for invalid path
* @since 6.0.0
*/
class InvalidPathException extends \Exception {}

7
lib/public/files/irootfolder.php
Unescape Escape View File

@ -25,7 +25,12 @@ namespace OCP\Files;
use OC\Hooks\Emitter;
/**
* Interface IRootFolder
*
* @package OCP\Files
* @since 8.0.0
*/
interface IRootFolder extends Folder, Emitter {
}

1
lib/public/files/locknotacquiredexception.php
Unescape Escape View File

@ -32,6 +32,7 @@ namespace OCP\Files;
/**
* Exception for a file that is locked
* @since 7.0.0
*/
class LockNotAcquiredException extends \Exception {
/** @var string $path The path that could not be locked */

9
lib/public/files/mount/imountpoint.php
Unescape Escape View File

@ -24,6 +24,7 @@ namespace OCP\Files\Mount;
/**
* A storage mounted to folder on the filesystem
* @since 8.0.0
*/
interface IMountPoint {
@ -31,6 +32,7 @@ interface IMountPoint {
* get complete path to the mount point
*
* @return string
* @since 8.0.0
*/
public function getMountPoint();
@ -38,6 +40,7 @@ interface IMountPoint {
* Set the mountpoint
*
* @param string $mountPoint new mount point
* @since 8.0.0
*/
public function setMountPoint($mountPoint);
@ -45,6 +48,7 @@ interface IMountPoint {
* Get the storage that is mounted
*
* @return \OC\Files\Storage\Storage
* @since 8.0.0
*/
public function getStorage();
@ -52,6 +56,7 @@ interface IMountPoint {
* Get the id of the storages
*
* @return string
* @since 8.0.0
*/
public function getStorageId();
@ -60,6 +65,7 @@ interface IMountPoint {
*
* @param string $path absolute path to a file or folder
* @return string
* @since 8.0.0
*/
public function getInternalPath($path);
@ -67,6 +73,7 @@ interface IMountPoint {
* Apply a storage wrapper to the mounted storage
*
* @param callable $wrapper
* @since 8.0.0
*/
public function wrapStorage($wrapper);
@ -76,6 +83,7 @@ interface IMountPoint {
* @param string $name Name of the mount option to get
* @param mixed $default Default value for the mount option
* @return mixed
* @since 8.0.0
*/
public function getOption($name, $default);
@ -83,6 +91,7 @@ interface IMountPoint {
* Get all options for the mount
*
* @return array
* @since 8.1.0
*/
public function getOptions();
}

25
lib/public/files/node.php
Unescape Escape View File

@ -32,6 +32,12 @@
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP\Files;
/**
* Interface Node
*
* @package OCP\Files
* @since 6.0.0 - extends FileInfo was added in 8.0.0
*/
interface Node extends FileInfo {
/**
* Move the file or folder to a new location
@ -39,12 +45,14 @@ interface Node extends FileInfo {
* @param string $targetPath the absolute target path
* @throws \OCP\Files\NotPermittedException
* @return \OCP\Files\Node
* @since 6.0.0
*/
public function move($targetPath);
/**
* Delete the file or folder
* @return void
* @since 6.0.0
*/
public function delete();
@ -53,6 +61,7 @@ interface Node extends FileInfo {
*
* @param string $targetPath the absolute target path
* @return \OCP\Files\Node
* @since 6.0.0
*/
public function copy($targetPath);
@ -63,6 +72,7 @@ interface Node extends FileInfo {
* @param int $mtime (optional) modified date as unix timestamp
* @throws \OCP\Files\NotPermittedException
* @return void
* @since 6.0.0
*/
public function touch($mtime = null);
@ -71,6 +81,7 @@ interface Node extends FileInfo {
*
* @return \OCP\Files\Storage
* @throws \OCP\Files\NotFoundException
* @since 6.0.0
*/
public function getStorage();
@ -78,6 +89,7 @@ interface Node extends FileInfo {
* Get the full path of the file or folder
*
* @return string
* @since 6.0.0
*/
public function getPath();
@ -85,6 +97,7 @@ interface Node extends FileInfo {
* Get the path of the file or folder relative to the mountpoint of it's storage
*
* @return string
* @since 6.0.0
*/
public function getInternalPath();
@ -94,6 +107,7 @@ interface Node extends FileInfo {
* @return int
* @throws InvalidPathException
* @throws NotFoundException
* @since 6.0.0
*/
public function getId();
@ -104,6 +118,7 @@ interface Node extends FileInfo {
* - size
*
* @return array
* @since 6.0.0
*/
public function stat();
@ -113,6 +128,7 @@ interface Node extends FileInfo {
* @return int
* @throws InvalidPathException
* @throws NotFoundException
* @since 6.0.0
*/
public function getMTime();
@ -122,6 +138,7 @@ interface Node extends FileInfo {
* @return int
* @throws InvalidPathException
* @throws NotFoundException
* @since 6.0.0
*/
public function getSize();
@ -133,6 +150,7 @@ interface Node extends FileInfo {
* @return string
* @throws InvalidPathException
* @throws NotFoundException
* @since 6.0.0
*/
public function getEtag();
@ -148,6 +166,7 @@ interface Node extends FileInfo {
* @return int
* @throws InvalidPathException
* @throws NotFoundException
* @since 6.0.0 - namespace of constants has changed in 8.0.0
*/
public function getPermissions();
@ -157,6 +176,7 @@ interface Node extends FileInfo {
* @return bool
* @throws InvalidPathException
* @throws NotFoundException
* @since 6.0.0
*/
public function isReadable();
@ -166,6 +186,7 @@ interface Node extends FileInfo {
* @return bool
* @throws InvalidPathException
* @throws NotFoundException
* @since 6.0.0
*/
public function isUpdateable();
@ -175,6 +196,7 @@ interface Node extends FileInfo {
* @return bool
* @throws InvalidPathException
* @throws NotFoundException
* @since 6.0.0
*/
public function isDeletable();
@ -184,6 +206,7 @@ interface Node extends FileInfo {
* @return bool
* @throws InvalidPathException
* @throws NotFoundException
* @since 6.0.0
*/
public function isShareable();
@ -191,6 +214,7 @@ interface Node extends FileInfo {
* Get the parent folder of the file or folder
*
* @return Folder
* @since 6.0.0
*/
public function getParent();
@ -198,6 +222,7 @@ interface Node extends FileInfo {
* Get the filename of the file or folder
*
* @return string
* @since 6.0.0
*/
public function getName();
}

1
lib/public/files/notenoughspaceexception.php
Unescape Escape View File

@ -31,5 +31,6 @@ namespace OCP\Files;
/**
* Exception for not enough space
* @since 6.0.0
*/
class NotEnoughSpaceException extends \Exception {}

1
lib/public/files/notfoundexception.php
Unescape Escape View File

@ -31,5 +31,6 @@ namespace OCP\Files;
/**
* Exception for not found entity
* @since 6.0.0
*/
class NotFoundException extends \Exception {}

1
lib/public/files/notpermittedexception.php
Unescape Escape View File

@ -31,5 +31,6 @@ namespace OCP\Files;
/**
* Exception for not permitted action
* @since 6.0.0
*/
class NotPermittedException extends \Exception {}

18
lib/public/files/objectstore/iobjectstore.php
Unescape Escape View File

@ -21,32 +21,42 @@
*/
namespace OCP\Files\ObjectStore;
/**
* Interface IObjectStore
*
* @package OCP\Files\ObjectStore
* @since 7.0.0
*/
interface IObjectStore {
/**
* @return string the container or bucket name where objects are stored
* @since 7.0.0
*/
function getStorageId();
/**
* @param string $urn the unified resource name used to identify the object
* @return resource stream with the read data
* @throws Exception when something goes wrong, message will be logged
* @throws \Exception when something goes wrong, message will be logged
* @since 7.0.0
*/
function readObject($urn);
/**
* @param string $urn the unified resource name used to identify the object
* @param resource $stream stream with the data to write
* @throws Exception when something goes wrong, message will be logged
* @throws \Exception when something goes wrong, message will be logged
* @since 7.0.0
*/
function writeObject($urn, $stream);
/**
* @param string $urn the unified resource name used to identify the object
* @return void
* @throws Exception when something goes wrong, message will be logged
* @throws \Exception when something goes wrong, message will be logged
* @since 7.0.0
*/
function deleteObject($urn);
}
}

1
lib/public/files/reservedwordexception.php
Unescape Escape View File

@ -30,6 +30,7 @@ namespace OCP\Files;
/**
* Exception for invalid path
* @since 8.1.0
*/
class ReservedWordException extends InvalidPathException {

40
lib/public/files/storage.php
Unescape Escape View File

@ -38,6 +38,7 @@ use OCP\Files\InvalidPathException;
* Provide a common interface to all different storage options
*
* All paths passed to the storage are relative to the storage and should NOT have a leading slash.
* @since 6.0.0
*/
interface Storage {
/**
@ -45,6 +46,7 @@ interface Storage {
*
* @param array $parameters
* @return void
* @since 6.0.0
*/
public function __construct($parameters);
@ -54,6 +56,7 @@ interface Storage {
* and two storage objects with the same id should refer to two storages that display the same files.
*
* @return string
* @since 6.0.0
*/
public function getId();
@ -62,6 +65,7 @@ interface Storage {
*
* @param string $path
* @return bool
* @since 6.0.0
*/
public function mkdir($path);
@ -70,6 +74,7 @@ interface Storage {
*
* @param string $path
* @return bool
* @since 6.0.0
*/
public function rmdir($path);
@ -78,6 +83,7 @@ interface Storage {
*
* @param string $path
* @return resource|false
* @since 6.0.0
*/
public function opendir($path);
@ -86,6 +92,7 @@ interface Storage {
*
* @param string $path
* @return bool
* @since 6.0.0
*/
public function is_dir($path);
@ -94,6 +101,7 @@ interface Storage {
*
* @param string $path
* @return bool
* @since 6.0.0
*/
public function is_file($path);
@ -103,6 +111,7 @@ interface Storage {
*
* @param string $path
* @return array|false
* @since 6.0.0
*/
public function stat($path);
@ -111,6 +120,7 @@ interface Storage {
*
* @param string $path
* @return string|false
* @since 6.0.0
*/
public function filetype($path);
@ -120,6 +130,7 @@ interface Storage {
*
* @param string $path
* @return int|false
* @since 6.0.0
*/
public function filesize($path);
@ -128,6 +139,7 @@ interface Storage {
*
* @param string $path
* @return bool
* @since 6.0.0
*/
public function isCreatable($path);
@ -136,6 +148,7 @@ interface Storage {
*
* @param string $path
* @return bool
* @since 6.0.0
*/
public function isReadable($path);
@ -144,6 +157,7 @@ interface Storage {
*
* @param string $path
* @return bool
* @since 6.0.0
*/
public function isUpdatable($path);
@ -152,6 +166,7 @@ interface Storage {
*
* @param string $path
* @return bool
* @since 6.0.0
*/
public function isDeletable($path);
@ -160,6 +175,7 @@ interface Storage {
*
* @param string $path
* @return bool
* @since 6.0.0
*/
public function isSharable($path);
@ -169,6 +185,7 @@ interface Storage {
*
* @param string $path
* @return int
* @since 6.0.0
*/
public function getPermissions($path);
@ -177,6 +194,7 @@ interface Storage {
*
* @param string $path
* @return bool
* @since 6.0.0
*/
public function file_exists($path);
@ -185,6 +203,7 @@ interface Storage {
*
* @param string $path
* @return int|false
* @since 6.0.0
*/
public function filemtime($path);
@ -193,6 +212,7 @@ interface Storage {
*
* @param string $path
* @return string|false
* @since 6.0.0
*/
public function file_get_contents($path);
@ -202,6 +222,7 @@ interface Storage {
* @param string $path
* @param string $data
* @return bool
* @since 6.0.0
*/
public function file_put_contents($path, $data);
@ -210,6 +231,7 @@ interface Storage {
*
* @param string $path
* @return bool
* @since 6.0.0
*/
public function unlink($path);
@ -219,6 +241,7 @@ interface Storage {
* @param string $path1
* @param string $path2
* @return bool
* @since 6.0.0
*/
public function rename($path1, $path2);
@ -228,6 +251,7 @@ interface Storage {
* @param string $path1
* @param string $path2
* @return bool
* @since 6.0.0
*/
public function copy($path1, $path2);
@ -237,6 +261,7 @@ interface Storage {
* @param string $path
* @param string $mode
* @return resource|false
* @since 6.0.0
*/
public function fopen($path, $mode);
@ -246,6 +271,7 @@ interface Storage {
*
* @param string $path
* @return string|false
* @since 6.0.0
*/
public function getMimeType($path);
@ -256,6 +282,7 @@ interface Storage {
* @param string $path
* @param bool $raw
* @return string|false
* @since 6.0.0
*/
public function hash($type, $path, $raw = false);
@ -264,6 +291,7 @@ interface Storage {
*
* @param string $path
* @return int|false
* @since 6.0.0
*/
public function free_space($path);
@ -272,6 +300,7 @@ interface Storage {
*
* @param string $query
* @return array|false
* @since 6.0.0
*/
public function search($query);
@ -282,6 +311,7 @@ interface Storage {
* @param string $path
* @param int $mtime
* @return bool
* @since 6.0.0
*/
public function touch($path, $mtime = null);
@ -291,6 +321,7 @@ interface Storage {
*
* @param string $path
* @return string|false
* @since 6.0.0
*/
public function getLocalFile($path);
@ -300,6 +331,7 @@ interface Storage {
*
* @param string $path
* @return string|false
* @since 6.0.0
*/
public function getLocalFolder($path);
/**
@ -308,6 +340,7 @@ interface Storage {
* @param string $path
* @param int $time
* @return bool
* @since 6.0.0
*
* hasUpdated for folders should return at least true if a file inside the folder is add, removed or renamed.
* returning true for other changes in the folder is optional
@ -319,6 +352,7 @@ interface Storage {
*
* @param string $path
* @return string|false
* @since 6.0.0
*/
public function getETag($path);
@ -330,6 +364,7 @@ interface Storage {
* it might return a temporary file.
*
* @return bool true if the files are stored locally, false otherwise
* @since 7.0.0
*/
public function isLocal();
@ -338,6 +373,7 @@ interface Storage {
*
* @param string $class
* @return bool
* @since 7.0.0
*/
public function instanceOfStorage($class);
@ -348,6 +384,7 @@ interface Storage {
*
* @param string $path
* @return array|false
* @since 8.0.0
*/
public function getDirectDownload($path);
@ -356,6 +393,7 @@ interface Storage {
* @param string $fileName the name of the file itself
* @return void
* @throws InvalidPathException
* @since 8.1.0
*/
public function verifyPath($path, $fileName);
@ -364,6 +402,7 @@ interface Storage {
* @param string $sourceInternalPath
* @param string $targetInternalPath
* @return bool
* @since 8.1.0
*/
public function copyFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath);
@ -372,6 +411,7 @@ interface Storage {
* @param string $sourceInternalPath
* @param string $targetInternalPath
* @return bool
* @since 8.1.0
*/
public function moveFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath);
}

3
lib/public/files/storage/istoragefactory.php
Unescape Escape View File

@ -26,6 +26,7 @@ use OCP\Files\Mount\IMountPoint;
/**
* Creates storage instances and manages and applies storage wrappers
* @since 8.0.0
*/
interface IStorageFactory {
/**
@ -37,6 +38,7 @@ interface IStorageFactory {
* @param callable $callback
* @return bool true if the wrapper was added, false if there was already a wrapper with this
* name registered
* @since 8.0.0
*/
public function addStorageWrapper($wrapperName, $callback);
@ -45,6 +47,7 @@ interface IStorageFactory {
* @param string $class
* @param array $arguments
* @return \OCP\Files\Storage
* @since 8.0.0
*/
public function getInstance(IMountPoint $mountPoint, $class, $arguments);
}

1
lib/public/files/storageinvalidexception.php
Unescape Escape View File

@ -31,6 +31,7 @@ namespace OCP\Files;
/**
* Storage has invalid configuration
* @since 7.0.0
*/
class StorageInvalidException extends \Exception {
}

1
lib/public/files/storagenotavailableexception.php
Unescape Escape View File

@ -31,6 +31,7 @@ namespace OCP\Files;
/**
* Storage is temporarily not available
* @since 6.0.0
*/
class StorageNotAvailableException extends \Exception {
}

6
lib/public/groupinterface.php
Unescape Escape View File

@ -31,4 +31,10 @@
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP;
/**
* Interface GroupInterface
*
* @package OCP
* @since 4.5.0
*/
interface GroupInterface extends \OC_Group_Interface {}

7
lib/public/http/client/iclient.php
Unescape Escape View File

@ -25,6 +25,7 @@ namespace OCP\Http\Client;
* Interface IClient
*
* @package OCP\Http
* @since 8.1.0
*/
interface IClient {
@ -54,6 +55,7 @@ interface IClient {
* 'debug' => true,
* @return IResponse
* @throws \Exception If the request could not get completed
* @since 8.1.0
*/
public function get($uri, array $options = []);
@ -77,6 +79,7 @@ interface IClient {
* 'verify' => true, // bool or string to CA file
* 'debug' => true,
* @return IResponse
* @since 8.1.0
*/
public function head($uri, $options = []);
@ -105,6 +108,7 @@ interface IClient {
* 'verify' => true, // bool or string to CA file
* 'debug' => true,
* @return IResponse
* @since 8.1.0
*/
public function post($uri, array $options = []);
@ -133,6 +137,7 @@ interface IClient {
* 'verify' => true, // bool or string to CA file
* 'debug' => true,
* @return IResponse
* @since 8.1.0
*/
public function put($uri, array $options = []);
@ -161,6 +166,7 @@ interface IClient {
* 'verify' => true, // bool or string to CA file
* 'debug' => true,
* @return IResponse
* @since 8.1.0
*/
public function delete($uri, array $options = []);
@ -189,6 +195,7 @@ interface IClient {
* 'verify' => true, // bool or string to CA file
* 'debug' => true,
* @return IResponse
* @since 8.1.0
*/
public function options($uri, array $options = []);
}

2
lib/public/http/client/iclientservice.php
Unescape Escape View File

@ -25,10 +25,12 @@ namespace OCP\Http\Client;
* Interface IClientService
*
* @package OCP\Http
* @since 8.1.0
*/
interface IClientService {
/**
* @return IClient
* @since 8.1.0
*/
public function newClient();
}

5
lib/public/http/client/iresponse.php
Unescape Escape View File

@ -25,26 +25,31 @@ namespace OCP\Http\Client;
* Interface IResponse
*
* @package OCP\Http
* @since 8.1.0
*/
interface IResponse {
/**
* @return string
* @since 8.1.0
*/
public function getBody();
/**
* @return int
* @since 8.1.0
*/
public function getStatusCode();
/**
* @param $key
* @return string
* @since 8.1.0
*/
public function getHeader($key);
/**
* @return array
* @since 8.1.0
*/
public function getHeaders();
}

12
lib/public/iaddressbook.php
Unescape Escape View File

@ -30,16 +30,24 @@
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP {
/**
* Interface IAddressBook
*
* @package OCP
* @since 5.0.0
*/
interface IAddressBook {
/**
* @return string defining the technical unique key
* @since 5.0.0
*/
public function getKey();
/**
* In comparison to getKey() this function returns a human readable (maybe translated) name
* @return mixed
* @since 5.0.0
*/
public function getDisplayName();
@ -48,6 +56,7 @@ namespace OCP {
* @param array $searchProperties defines the properties within the query pattern should match
* @param array $options - for future use. One should always have options!
* @return array an array of contacts which are arrays of key-value-pairs
* @since 5.0.0
*/
public function search($pattern, $searchProperties, $options);
// // dummy results
@ -59,6 +68,7 @@ namespace OCP {
/**
* @param array $properties this array if key-value-pairs defines a contact
* @return array an array representing the contact just created or updated
* @since 5.0.0
*/
public function createOrUpdate($properties);
// // dummy
@ -69,12 +79,14 @@ namespace OCP {
/**
* @return mixed
* @since 5.0.0
*/
public function getPermissions();
/**
* @param object $id the unique identifier to a contact
* @return bool successful or not
* @since 5.0.0
*/
public function delete($id);
}

9
lib/public/iappconfig.php
Unescape Escape View File

@ -27,6 +27,7 @@ namespace OCP;
/**
* This class provides an easy way for apps to store config values in the
* database.
* @since 7.0.0
*/
interface IAppConfig {
/**
@ -34,6 +35,7 @@ interface IAppConfig {
* @param string $app
* @param string $key
* @return bool
* @since 7.0.0
*/
public function hasKey($app, $key);
@ -47,6 +49,7 @@ interface IAppConfig {
*
* This function gets a value from the appconfig table. If the key does
* not exist the default value will be returned
* @since 7.0.0
*/
public function getValue($app, $key, $default = null);
@ -56,6 +59,7 @@ interface IAppConfig {
* @param string $key key
* @return bool
* @deprecated use method deleteAppValue of \OCP\IConfig
* @since 7.0.0
*/
public function deleteKey($app, $key);
@ -67,6 +71,7 @@ interface IAppConfig {
*
* This function gets all keys of an app. Please note that the values are
* not returned.
* @since 7.0.0
*/
public function getKeys($app);
@ -76,6 +81,7 @@ interface IAppConfig {
* @param string|false $key
* @param string|false $app
* @return array|false
* @since 7.0.0
*/
public function getValues($app, $key);
@ -88,6 +94,7 @@ interface IAppConfig {
*
* Sets a value. If the key did not exist before it will be created.
* @return void
* @since 7.0.0
*/
public function setValue($app, $key, $value);
@ -97,6 +104,7 @@ interface IAppConfig {
*
* This function returns a list of all apps that have at least one
* entry in the appconfig table.
* @since 7.0.0
*/
public function getApps();
@ -107,6 +115,7 @@ interface IAppConfig {
* @deprecated use method deleteAppValue of \OCP\IConfig
*
* Removes all keys in appconfig belonging to the app.
* @since 7.0.0
*/
public function deleteApp($app);
}

6
lib/public/iavatar.php
Unescape Escape View File

@ -27,14 +27,15 @@ namespace OCP;
/**
* This class provides avatar functionality
* @since 6.0.0
*/
interface IAvatar {
/**
* get the users avatar
* @param int $size size in px of the avatar, avatars are square, defaults to 64
* @return boolean|\OCP\IImage containing the avatar or false if there's no image
* @since 6.0.0
*/
function get($size = 64);
@ -42,6 +43,7 @@ interface IAvatar {
* Check if an avatar exists for the user
*
* @return bool
* @since 8.1.0
*/
public function exists();
@ -52,12 +54,14 @@ interface IAvatar {
* @throws \Exception if the provided image is not valid
* @throws \OC\NotSquareException if the image is not square
* @return void
* @since 6.0.0
*/
function set($data);
/**
* remove the users avatar
* @return void
* @since 6.0.0
*/
function remove();
}

2
lib/public/iavatarmanager.php
Unescape Escape View File

@ -26,6 +26,7 @@ namespace OCP;
/**
* This class provides avatar functionality
* @since 6.0.0
*/
interface IAvatarManager {
@ -35,6 +36,7 @@ interface IAvatarManager {
* @see \OCP\IAvatar
* @param string $user the ownCloud user id
* @return \OCP\IAvatar
* @since 6.0.0
*/
function getAvatar($user);
}

6
lib/public/icache.php
Unescape Escape View File

@ -33,6 +33,7 @@ namespace OCP;
/**
* This interface defines method for accessing the file based user cache.
* @since 6.0.0
*/
interface ICache {
@ -40,6 +41,7 @@ interface ICache {
* Get a value from the user cache
* @param string $key
* @return mixed
* @since 6.0.0
*/
public function get($key);
@ -49,6 +51,7 @@ interface ICache {
* @param mixed $value
* @param int $ttl Time To Live in seconds. Defaults to 60*60*24
* @return bool
* @since 6.0.0
*/
public function set($key, $value, $ttl = 0);
@ -56,6 +59,7 @@ interface ICache {
* Check if a value is set in the user cache
* @param string $key
* @return bool
* @since 6.0.0
*/
public function hasKey($key);
@ -63,6 +67,7 @@ interface ICache {
* Remove an item from the user cache
* @param string $key
* @return bool
* @since 6.0.0
*/
public function remove($key);
@ -70,6 +75,7 @@ interface ICache {
* Clear the user cache of all entries starting with a prefix
* @param string $prefix (optional)
* @return bool
* @since 6.0.0
*/
public function clear($prefix = '');
}

8
lib/public/icachefactory.php
Unescape Escape View File

@ -22,6 +22,12 @@
namespace OCP;
/**
* Interface ICacheFactory
*
* @package OCP
* @since 7.0.0
*/
interface ICacheFactory{
/**
* Get a memory cache instance
@ -30,6 +36,7 @@ interface ICacheFactory{
*
* @param string $prefix
* @return \OCP\ICache
* @since 7.0.0
*/
public function create($prefix = '');
@ -37,6 +44,7 @@ interface ICacheFactory{
* Check if any memory cache backend is available
*
* @return bool
* @since 7.0.0
*/
public function isAvailable();
}

14
lib/public/icertificate.php
Unescape Escape View File

@ -22,44 +22,58 @@
namespace OCP;
/**
* Interface ICertificate
*
* @package OCP
* @since 8.0.0
*/
interface ICertificate {
/**
* @return string
* @since 8.0.0
*/
public function getName();
/**
* @return string
* @since 8.0.0
*/
public function getCommonName();
/**
* @return string
* @since 8.0.0
*/
public function getOrganization();
/**
* @return \DateTime
* @since 8.0.0
*/
public function getIssueDate();
/**
* @return \DateTime
* @since 8.0.0
*/
public function getExpireDate();
/**
* @return bool
* @since 8.0.0
*/
public function isExpired();
/**
* @return string
* @since 8.0.0
*/
public function getIssuerName();
/**
* @return string
* @since 8.0.0
*/
public function getIssuerOrganization();
}

5
lib/public/icertificatemanager.php
Unescape Escape View File

@ -24,12 +24,14 @@ namespace OCP;
/**
* Manage trusted certificates for users
* @since 8.0.0
*/
interface ICertificateManager {
/**
* Returns all certificates trusted by the user
*
* @return \OCP\ICertificate[]
* @since 8.0.0
*/
public function listCertificates();
@ -37,11 +39,13 @@ interface ICertificateManager {
* @param string $certificate the certificate data
* @param string $name the filename for the certificate
* @return bool | \OCP\ICertificate
* @since 8.0.0
*/
public function addCertificate($certificate, $name);
/**
* @param string $name
* @since 8.0.0
*/
public function removeCertificate($name);
@ -49,6 +53,7 @@ interface ICertificateManager {
* Get the path to the certificate bundle for this user
*
* @return string
* @since 8.0.0
*/
public function getCertificateBundle();
}

18
lib/public/iconfig.php
Unescape Escape View File

@ -37,6 +37,7 @@ namespace OCP;
/**
* Access to all the configuration options ownCloud offers
* @since 6.0.0
*/
interface IConfig {
/**
@ -44,6 +45,7 @@ interface IConfig {
*
* @param array $configs Associative array with `key => value` pairs
* If value is null, the config key will be deleted
* @since 8.0.0
*/
public function setSystemValues(array $configs);
@ -52,6 +54,7 @@ interface IConfig {
*
* @param string $key the key of the value, under which will be saved
* @param mixed $value the value that should be stored
* @since 8.0.0
*/
public function setSystemValue($key, $value);
@ -61,6 +64,7 @@ interface IConfig {
* @param string $key the key of the value, under which it was saved
* @param mixed $default the default value to be returned if the value isn't set
* @return mixed the value or $default
* @since 6.0.0 - parameter $default was added in 7.0.0
*/
public function getSystemValue($key, $default = '');
@ -68,6 +72,7 @@ interface IConfig {
* Delete a system wide defined value
*
* @param string $key the key of the value, under which it was saved
* @since 8.0.0
*/
public function deleteSystemValue($key);
@ -76,6 +81,7 @@ interface IConfig {
*
* @param string $appName the appName that we stored the value under
* @return string[] the keys stored for the app
* @since 8.0.0
*/
public function getAppKeys($appName);
@ -86,6 +92,7 @@ interface IConfig {
* @param string $key the key of the value, under which will be saved
* @param string $value the value that should be stored
* @return void
* @since 6.0.0
*/
public function setAppValue($appName, $key, $value);
@ -96,6 +103,7 @@ interface IConfig {
* @param string $key the key of the value, under which it was saved
* @param string $default the default value to be returned if the value isn't set
* @return string the saved value
* @since 6.0.0 - parameter $default was added in 7.0.0
*/
public function getAppValue($appName, $key, $default = '');
@ -104,6 +112,7 @@ interface IConfig {
*
* @param string $appName the appName that we stored the value under
* @param string $key the key of the value, under which it was saved
* @since 8.0.0
*/
public function deleteAppValue($appName, $key);
@ -111,6 +120,7 @@ interface IConfig {
* Removes all keys in appconfig belonging to the app
*
* @param string $appName the appName the configs are stored under
* @since 8.0.0
*/
public function deleteAppValues($appName);
@ -124,6 +134,7 @@ interface IConfig {
* @param string $value the value that you want to store
* @param string $preCondition only update if the config value was previously the value passed as $preCondition
* @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met
* @since 6.0.0 - parameter $precondition was added in 8.0.0
*/
public function setUserValue($userId, $appName, $key, $value, $preCondition = null);
@ -135,6 +146,7 @@ interface IConfig {
* @param string $key the key under which the value is being stored
* @param mixed $default the default value to be returned if the value isn't set
* @return string
* @since 6.0.0 - parameter $default was added in 7.0.0
*/
public function getUserValue($userId, $appName, $key, $default = '');
@ -145,6 +157,7 @@ interface IConfig {
* @param string $key the key to get the value for
* @param array $userIds the user IDs to fetch the values for
* @return array Mapped values: userId => value
* @since 8.0.0
*/
public function getUserValueForUsers($appName, $key, $userIds);
@ -154,6 +167,7 @@ interface IConfig {
* @param string $userId the userId of the user that we want to store the value under
* @param string $appName the appName that we stored the value under
* @return string[]
* @since 8.0.0
*/
public function getUserKeys($userId, $appName);
@ -163,6 +177,7 @@ interface IConfig {
* @param string $userId the userId of the user that we want to store the value under
* @param string $appName the appName that we stored the value under
* @param string $key the key under which the value is being stored
* @since 8.0.0
*/
public function deleteUserValue($userId, $appName, $key);
@ -170,6 +185,7 @@ interface IConfig {
* Delete all user values
*
* @param string $userId the userId of the user that we want to remove all values from
* @since 8.0.0
*/
public function deleteAllUserValues($userId);
@ -177,6 +193,7 @@ interface IConfig {
* Delete all user related values of one app
*
* @param string $appName the appName of the app that we want to remove all values from
* @since 8.0.0
*/
public function deleteAppFromAllUsers($appName);
@ -187,6 +204,7 @@ interface IConfig {
* @param string $key the key to get the user for
* @param string $value the value to get the user for
* @return array of user IDs
* @since 8.0.0
*/
public function getUsersForUserValue($appName, $key, $value);
}

4
lib/public/icontainer.php
Unescape Escape View File

@ -36,6 +36,7 @@ namespace OCP;
* IContainer is the basic interface to be used for any internal dependency injection mechanism
*
* @package OCP
* @since 6.0.0
*/
interface IContainer {
@ -44,6 +45,7 @@ interface IContainer {
*
* @param string $name
* @return mixed
* @since 6.0.0
*/
function query($name);
@ -53,6 +55,7 @@ interface IContainer {
* @param string $name
* @param mixed $value
* @return void
* @since 6.0.0
*/
function registerParameter($name, $value);
@ -67,6 +70,7 @@ interface IContainer {
* @param \Closure $closure
* @param bool $shared
* @return void
* @since 6.0.0
*/
function registerService($name, \Closure $closure, $shared = true);
}

13
lib/public/idatetimeformatter.php
Unescape Escape View File

@ -22,6 +22,12 @@
namespace OCP;
/**
* Interface IDateTimeFormatter
*
* @package OCP
* @since 8.0.0
*/
interface IDateTimeFormatter {
/**
* Formats the date of the given timestamp
@ -36,6 +42,7 @@ interface IDateTimeFormatter {
* @param \DateTimeZone $timeZone The timezone to use
* @param \OCP\IL10N $l The locale to use
* @return string Formatted date string
* @since 8.0.0
*/
public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
@ -53,6 +60,7 @@ interface IDateTimeFormatter {
* @param \DateTimeZone $timeZone The timezone to use
* @param \OCP\IL10N $l The locale to use
* @return string Formatted relative date string
* @since 8.0.0
*/
public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
@ -68,6 +76,7 @@ interface IDateTimeFormatter {
* >= 13 month => last year, n years ago
* @param \OCP\IL10N $l The locale to use
* @return string Formatted date span
* @since 8.0.0
*/
public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null);
@ -84,6 +93,7 @@ interface IDateTimeFormatter {
* @param \DateTimeZone $timeZone The timezone to use
* @param \OCP\IL10N $l The locale to use
* @return string Formatted time string
* @since 8.0.0
*/
public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
@ -101,6 +111,7 @@ interface IDateTimeFormatter {
* >= 13 month => last year, n years ago
* @param \OCP\IL10N $l The locale to use
* @return string Formatted time span
* @since 8.0.0
*/
public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null);
@ -113,6 +124,7 @@ interface IDateTimeFormatter {
* @param \DateTimeZone $timeZone The timezone to use
* @param \OCP\IL10N $l The locale to use
* @return string Formatted date and time string
* @since 8.0.0
*/
public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
@ -126,6 +138,7 @@ interface IDateTimeFormatter {
* @param \DateTimeZone $timeZone The timezone to use
* @param \OCP\IL10N $l The locale to use
* @return string Formatted relative date and time string
* @since 8.0.0
*/
public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
}

8
lib/public/idatetimezone.php
Unescape Escape View File

@ -22,11 +22,17 @@
namespace OCP;
/**
* Interface IDateTimeZone
*
* @package OCP
* @since 8.0.0
*/
interface IDateTimeZone {
/**
* @param bool|int $timestamp
* @return \DateTimeZone
* @since 8.0.0 - parameter $timestamp was added in 8.1.0
*/
public function getTimeZone($timestamp = false);
}

3
lib/public/idb.php
Unescape Escape View File

@ -25,6 +25,7 @@ namespace OCP;
/**
* Small Facade for being able to inject the database connection for tests
* @since 7.0.0 - extends IDBConnection was added in 8.1.0
*/
interface IDb extends IDBConnection {
@ -35,6 +36,7 @@ interface IDb extends IDBConnection {
* @param int $limit the maximum number of rows
* @param int $offset from which row we want to start
* @return \OC_DB_StatementWrapper prepared SQL query
* @since 7.0.0
*/
public function prepareQuery($sql, $limit=null, $offset=null);
@ -43,6 +45,7 @@ interface IDb extends IDBConnection {
* Used to get the id of the just inserted element
* @param string $tableName the name of the table where we inserted the item
* @return int the id of the inserted element
* @since 7.0.0
*/
public function getInsertId($tableName);

22
lib/public/idbconnection.php
Unescape Escape View File

@ -34,7 +34,10 @@
namespace OCP;
/**
* TODO: Description
* Interface IDBConnection
*
* @package OCP
* @since 6.0.0
*/
interface IDBConnection {
/**
@ -43,6 +46,7 @@ interface IDBConnection {
* @param int $limit the maximum number of rows
* @param int $offset from which row we want to start
* @return \Doctrine\DBAL\Driver\Statement The prepared statement.
* @since 6.0.0
*/
public function prepare($sql, $limit=null, $offset=null);
@ -56,6 +60,7 @@ interface IDBConnection {
* @param string[] $params The parameters to bind to the query, if any.
* @param array $types The types the previous parameters are in.
* @return \Doctrine\DBAL\Driver\Statement The executed statement.
* @since 8.0.0
*/
public function executeQuery($query, array $params = array(), $types = array());
@ -69,6 +74,7 @@ interface IDBConnection {
* @param array $params The query parameters.
* @param array $types The parameter types.
* @return integer The number of affected rows.
* @since 8.0.0
*/
public function executeUpdate($query, array $params = array(), array $types = array());
@ -76,6 +82,7 @@ interface IDBConnection {
* Used to get the id of the just inserted element
* @param string $table the name of the table where we inserted the item
* @return int the id of the inserted element
* @since 6.0.0
*/
public function lastInsertId($table = null);
@ -89,27 +96,32 @@ interface IDBConnection {
* Please note: text fields (clob) must not be used in the compare array
* @return int number of inserted rows
* @throws \Doctrine\DBAL\DBALException
* @since 6.0.0 - parameter $compare was added in 8.1.0, return type changed from boolean in 8.1.0
*/
public function insertIfNotExist($table, $input, array $compare = null);
/**
* Start a transaction
* @since 6.0.0
*/
public function beginTransaction();
/**
* Commit the database changes done during a transaction that is in progress
* @since 6.0.0
*/
public function commit();
/**
* Rollback the database changes done during a transaction that is in progress
* @since 6.0.0
*/
public function rollBack();
/**
* Gets the error code and message as a string for logging
* @return string
* @since 6.0.0
*/
public function getError();
@ -117,6 +129,7 @@ interface IDBConnection {
* Fetch the SQLSTATE associated with the last database operation.
*
* @return integer The last error code.
* @since 8.0.0
*/
public function errorCode();
@ -124,6 +137,7 @@ interface IDBConnection {
* Fetch extended error information associated with the last database operation.
*
* @return array The last error information.
* @since 8.0.0
*/
public function errorInfo();
@ -131,11 +145,13 @@ interface IDBConnection {
* Establishes the connection with the database.
*
* @return bool
* @since 8.0.0
*/
public function connect();
/**
* Close the database connection
* @since 8.0.0
*/
public function close();
@ -145,6 +161,7 @@ interface IDBConnection {
* @param mixed $input Parameter to be quoted.
* @param int $type Type of the parameter.
* @return string The quoted parameter.
* @since 8.0.0
*/
public function quote($input, $type = \PDO::PARAM_STR);
@ -153,6 +170,7 @@ interface IDBConnection {
* the platform this driver connects to.
*
* @return \Doctrine\DBAL\Platforms\AbstractPlatform The database platform.
* @since 8.0.0
*/
public function getDatabasePlatform();
@ -160,6 +178,7 @@ interface IDBConnection {
* Drop a table from the database if it exists
*
* @param string $table table name without the prefix
* @since 8.0.0
*/
public function dropTable($table);
@ -168,6 +187,7 @@ interface IDBConnection {
*
* @param string $table table name without the prefix
* @return bool
* @since 8.0.0
*/
public function tableExists($table);
}

3
lib/public/ieventsource.php
Unescape Escape View File

@ -29,6 +29,7 @@ namespace OCP;
* use server side events with caution, to many open requests can hang the server
*
* The event source will initialize the connection to the client when the first data is sent
* @since 8.0.0
*/
interface IEventSource {
/**
@ -38,11 +39,13 @@ interface IEventSource {
* @param mixed $data
*
* if only one parameter is given, a typeless message will be send with that parameter as data
* @since 8.0.0
*/
public function send($type, $data = null);
/**
* close the connection of the event source
* @since 8.0.0
*/
public function close();
}

15
lib/public/igroup.php
Unescape Escape View File

@ -22,9 +22,16 @@
namespace OCP;
/**
* Interface IGroup
*
* @package OCP
* @since 8.0.0
*/
interface IGroup {
/**
* @return string
* @since 8.0.0
*/
public function getGID();
@ -32,6 +39,7 @@ interface IGroup {
* get all users in the group
*
* @return \OCP\IUser[]
* @since 8.0.0
*/
public function getUsers();
@ -40,6 +48,7 @@ interface IGroup {
*
* @param \OCP\IUser $user
* @return bool
* @since 8.0.0
*/
public function inGroup($user);
@ -47,6 +56,7 @@ interface IGroup {
* add a user to the group
*
* @param \OCP\IUser $user
* @since 8.0.0
*/
public function addUser($user);
@ -54,6 +64,7 @@ interface IGroup {
* remove a user from the group
*
* @param \OCP\IUser $user
* @since 8.0.0
*/
public function removeUser($user);
@ -64,6 +75,7 @@ interface IGroup {
* @param int $limit
* @param int $offset
* @return \OCP\IUser[]
* @since 8.0.0
*/
public function searchUsers($search, $limit = null, $offset = null);
@ -72,6 +84,7 @@ interface IGroup {
*
* @param string $search
* @return int|bool
* @since 8.0.0
*/
public function count($search = '');
@ -82,6 +95,7 @@ interface IGroup {
* @param int $limit
* @param int $offset
* @return \OCP\IUser[]
* @since 8.0.0
*/
public function searchDisplayName($search, $limit = null, $offset = null);
@ -89,6 +103,7 @@ interface IGroup {
* delete the group
*
* @return bool
* @since 8.0.0
*/
public function delete();
}

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