\OCP

Namespaces

Activity
App
AppFramework
Authentication
BackgroundJob
Capabilities
Command
Comments
Console
Contacts
DB
Diagnostics
Encryption
Files
Http
L10N
Lock
Mail
Migration
Notification
Preview
Route
Search
Security
Session
Settings
Share
SystemTag
User

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
ICache This interface defines method for accessing the file based user cache.
ICacheFactory Interface ICacheFactory
ICertificate Interface ICertificate
ICertificateManager Manage trusted certificates for users
IConfig Access to all the configuration options ownCloud offers
IContainer Class IContainer
IDateTimeFormatter Interface IDateTimeFormatter
IDateTimeZone Interface IDateTimeZone
IDb Small Facade for being able to inject the database connection for tests
IDBConnection Interface IDBConnection
IEventSource wrapper for server side events (http://en.wikipedia.org/wiki/Server-sent_events) includes a fallback for older browsers and IE
IGroup Interface IGroup
IGroupManager Class Manager
IHelper Functions that don't have any specific interface to place
IImage Class for basic image manipulation
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
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.
ISearch Small Interface for Search
IServerContainer Class IServerContainer
ISession Interface ISession
ISubAdminManager Sub admin manager
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

API This class provides functions to manage apps in ownCloud
App This class provides functions to manage apps in ownCloud
AutoloadNotAllowedException Exception for when a not allowed path is attempted to be autoloaded
BackgroundJob This class provides functions to register backgroundjobs in ownCloud
Config This class provides functions to read and write configuration data.
Constants Class Constants
Contacts This class provides access to the contacts app. Use this class exclusively if you want to access contacts.
DB This class provides access to the internal database system. Use this class exlusively if you want to access databases
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 exlusively if you want to access files
Image This class provides functions to handle images
JSON This class provides convenient functions to generate and send JSON data. Useful for Ajax calls
PreConditionNotMetException Exception if the precondition of the config update method isn't met
Response This class provides convenient functions to send the correct http response headers
SabrePluginEvent
SabrePluginException
Share This class provides the ability for apps to share their content between users.
Template This class provides the template system for owncloud. You can use it to load specific templates, add data and generate the html code
User This class provides access to the user management. You can get information about the currently logged in user and the permissions for example
Util This class provides different helper functions to make the life of a developer easier

Constants

FILENAME_INVALID_CHARS

FILENAME_INVALID_CHARS

PERMISSION_ALL

PERMISSION_ALL

PERMISSION_CREATE

PERMISSION_CREATE

PERMISSION_DELETE

PERMISSION_DELETE

PERMISSION_READ

PERMISSION_READ

PERMISSION_SHARE

PERMISSION_SHARE

PERMISSION_UPDATE

PERMISSION_UPDATE

Functions

html_select_options()

html_select_options(array  $options, mixed  $selected, array  $params = array()) : string

Generate html code for an options block.

Parameters

array $options

the options

mixed $selected

which one is selected?

array $params

the parameters

Returns

string —

html options

human_file_size()

human_file_size(integer  $bytes) : string

Make OC_Helper::humanFileSize available as a simple function Example: 2048 to 2 kB.

Parameters

integer $bytes

in bytes

Returns

string —

size as string

image_path()

image_path(string  $app, string  $image) : string

Make OC_Helper::imagePath available as a simple function

Parameters

string $app
string $image

Returns

string —

to the image

mimetype_icon()

mimetype_icon(string  $mimetype) : string

Make OC_Helper::mimetypeIcon available as a simple function

Parameters

string $mimetype

Returns

string —

to the image of this file type.

preview_icon()

preview_icon(string  $path) : string

Make preview_icon available as a simple function

Parameters

string $path

path to file

Returns

string —

to the preview of the image

publicPreview_icon()

publicPreview_icon(string  $path, string  $token) : string

Make publicpreview_icon available as a simple function Returns the path to the preview of the image.

Parameters

string $path

of file

string $token

Returns

string —

link to the preview

relative_modified_date()

relative_modified_date(integer  $timestamp, boolean  $dateOnly = false) : \OC_L10N_String

Return the relative date in relation to today. Returns something like "last hour" or "two month ago"

Parameters

integer $timestamp

unix timestamp

boolean $dateOnly

Returns

\OC_L10N_String —

human readable interpretation of the timestamp

simple_file_size()

simple_file_size(integer  $bytes) : string

Return a human readable outout for a file size.

Parameters

integer $bytes

size of a file in byte

Returns

string —

human readable interpretation of a file size