Nextcloud PHP API (master)

OCP

Table of Contents

Namespaces

Interfaces

GroupInterface: TODO actually this is a IGroupBackend
IAddressBook: Interface IAddressBook
IAppConfig: This class provides an easy way for apps to store config values in the database.
IAvatar: This class provides avatar functionality
IAvatarManager: This class provides avatar functionality
IBinaryFinder: Service that find the binary path for a program.
ICache: This interface defines method for accessing the file based user cache.
ICacheFactory: Interface ICacheFactory
ICertificate: Interface ICertificate
ICertificateManager: Manage trusted certificates
IConfig: Access to all the configuration options Nextcloud offers.
IContainer: Class IContainer
IDateTimeFormatter: Interface IDateTimeFormatter
IDateTimeZone: Interface IDateTimeZone
IDBConnection: Interface IDBConnection
IEmojiHelper
IEventSource: wrapper for server side events (http://en.wikipedia.org/wiki/Server-sent_events) includes a fallback for older browsers and IE
IEventSourceFactory
IGroup: Interface IGroup
IGroupManager: Class Manager
IImage: Class for basic image manipulation
IInitialStateService
IL10N: Interface IL10N
ILogger: Interface ILogger
IMemcache: This interface defines method for accessing the file based user cache.
IMemcacheTTL: Interface for memcache backends that support setting ttl after the value is set
INavigationManager: Manages the ownCloud navigation
IPhoneNumberUtil
IPreview: This class provides functions to render and show thumbnails and previews of files
IRequest: This interface provides an immutable object with with accessors to request variables and headers.
IRequestId
ISearch: Small Interface for Search
IServerContainer: This is a tagging interface for the server container
ISession: Interface ISession
IStreamImage: Class for basic image manipulation
ITagManager: Factory class creating instances of \OCP\ITags
ITags: Class for easily tagging objects by their id
ITempManager: Interface ITempManager
IURLGenerator: Class to generate URLs
IUser: Interface IUser
IUserBackend: Interface IUserBackend
IUserManager: Class Manager
IUserSession: User session
Share_Backend: Interface that apps must implement to share content.
Share_Backend_Collection: Interface for collections of of items implemented by another share backend.
Share_Backend_File_Dependent: Interface for share backends that share content that is dependent on files.
UserInterface: TODO actually this is a IUserBackend

Classes

AutoloadNotAllowedException: Exception for when a not allowed path is attempted to be autoloaded
BeforeSabrePubliclyLoadedEvent: Dispatched before Sabre is loaded when accessing public webdav endpoints This can be used to inject a Sabre plugin for example
Color: Simple RGB color container
Constants: Class Constants
Defaults: public api to access default strings and urls for your templates
Files: This class provides access to the internal filesystem abstraction layer. Use this class exclusively if you want to access files
HintException: Class HintException
Image: This class provides functions to handle images
PreConditionNotMetException: Exception if the precondition of the config update method isn't met
SabrePluginEvent: Base event class for the event dispatcher service
SabrePluginException
Server: Class allowing to inject services into your application. You should use whenever possible dependency injections instead.
Share: This class remains only for use with the ::class namespace used for various hooks
Template: This class provides the template system for owncloud. You can use it to load specific templates, add data and generate the html code
Util: This class provides different helper functions to make the life of a developer easier