summaryrefslogtreecommitdiffstats
path: root/lib/public/iservercontainer.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/iservercontainer.php')
-rw-r--r--lib/public/iservercontainer.php61
1 files changed, 61 insertions, 0 deletions
diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php
index f4045faefef..dcb00caf496 100644
--- a/lib/public/iservercontainer.php
+++ b/lib/public/iservercontainer.php
@@ -20,6 +20,14 @@
*
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * Server container interface
+ *
+ */
+
+// 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;
@@ -92,16 +100,48 @@ interface IServerContainer {
function getUserSession();
/**
+ * Returns the navigation manager
+ *
* @return \OCP\INavigationManager
*/
function getNavigationManager();
/**
+ * Returns the config manager
+ *
* @return \OCP\IConfig
*/
function getConfig();
/**
+ * Returns the app config manager
+ *
+ * @return \OCP\IAppConfig
+ */
+ function getAppConfig();
+
+ /**
+ * get an L10N instance
+ * @param $app string appid
+ * @return \OCP\IL10N
+ */
+ function getL10N($app);
+
+ /**
+ * Returns the URL generator
+ *
+ * @return \OCP\IURLGenerator
+ */
+ function getURLGenerator();
+
+ /**
+ * Returns the Helper
+ *
+ * @return \OCP\IHelper
+ */
+ function getHelper();
+
+ /**
* Returns an ICache instance
*
* @return \OCP\ICache
@@ -109,6 +149,13 @@ interface IServerContainer {
function getCache();
/**
+ * Returns an \OCP\CacheFactory instance
+ *
+ * @return \OCP\ICacheFactory
+ */
+ function getMemCacheFactory();
+
+ /**
* Returns the current session
*
* @return \OCP\ISession
@@ -116,10 +163,24 @@ interface IServerContainer {
function getSession();
/**
+ * Returns the activity manager
+ *
+ * @return \OCP\Activity\IManager
+ */
+ function getActivityManager();
+
+ /**
* Returns the current session
*
* @return \OCP\IDBConnection
*/
function getDatabaseConnection();
+ /**
+ * Returns an avatar manager, used for avatar functionality
+ *
+ * @return \OCP\IAvatarManager
+ */
+ function getAvatarManager();
+
}