Better phpdoc and method naming

diff --git a/apps/files/ajax/newfile.php b/apps/files/ajax/newfile.php
index 1070246fca976be10e092a34f6e5eb4cf96b1dfa..46629e1b60244144993c83f46675a0ce4b32e49f 100644 (file)
--- a/apps/files/ajax/newfile.php
+++ b/apps/files/ajax/newfile.php
@@ -16,7 +16,7 @@ $content = isset( $_REQUEST['content'] ) ? $_REQUEST['content'] : '';
 $source = isset( $_REQUEST['source'] ) ? trim($_REQUEST['source'], '/\\') : '';
 
 if($source) {
-       $eventSource = \OC::$server->getEventSource();
+       $eventSource = \OC::$server->createEventSource();
 } else {
        OC_JSON::callCheck();
 }

diff --git a/apps/files/ajax/scan.php b/apps/files/ajax/scan.php
index eed620113ac13bab5fef1cb960347b0c643cdc0a..da5a2ce6f26f25b3c2d4aaafe84e4a8e550bcb00 100644 (file)
--- a/apps/files/ajax/scan.php
+++ b/apps/files/ajax/scan.php
@@ -15,7 +15,7 @@ if (isset($_GET['users'])) {
        $users = array(OC_User::getUser());
 }
 
-$eventSource = \OC::$server->getEventSource();
+$eventSource = \OC::$server->createEventSource();
 $listener = new ScanListener($eventSource);
 
 foreach ($users as $user) {

diff --git a/core/ajax/update.php b/core/ajax/update.php
index 89ce27983788005c298f683708db41ef7c43870a..2a586535e70daff2ebb3b6f02a025e809ddb5417 100644 (file)
--- a/core/ajax/update.php
+++ b/core/ajax/update.php
@@ -4,7 +4,7 @@ require_once '../../lib/base.php';
 
 if (OC::checkUpgrade(false)) {
        $l = new \OC_L10N('core');
-       $eventSource = \OC::$server->getEventSource();
+       $eventSource = \OC::$server->createEventSource();
        $updater = new \OC\Updater(\OC_Log::$object);
        $updater->listen('\OC\Updater', 'maintenanceStart', function () use ($eventSource, $l) {
                $eventSource->send('success', (string)$l->t('Turned on maintenance mode'));

diff --git a/lib/private/appframework/core/api.php b/lib/private/appframework/core/api.php
index 0dd3a5838686baa9736525c0fabc0d0b7889a45c..279f4bf97f7bef21c82e835c258403438c1c8752 100644 (file)
--- a/lib/private/appframework/core/api.php
+++ b/lib/private/appframework/core/api.php
@@ -114,7 +114,7 @@ class API implements IApi{
         * @return \OCP\IEventSource a new open EventSource class
         */
        public function openEventSource(){
-               return \OC::$server->getEventSource();
+               return \OC::$server->createEventSource();
        }
 
        /**

diff --git a/lib/private/server.php b/lib/private/server.php
index 1c3b1b03ce968e9fa107cc2f8f6f6047caddea86..0c663e8553a3c2d050491a594bfb59b4e36e4299 100644 (file)
--- a/lib/private/server.php
+++ b/lib/private/server.php
@@ -494,11 +494,11 @@ class Server extends SimpleContainer implements IServerContainer {
        }
 
        /**
-        * Returns a search instance
+        * Create a new event source
         *
         * @return \OCP\IEventSource
         */
-       function getEventSource() {
+       function createEventSource() {
                return new \OC_EventSource();
        }
 }

diff --git a/lib/public/ieventsource.php b/lib/public/ieventsource.php
index ea4bfc73d4227ea3887e20026da6a90ea3516c5e..eb7853c5e90c45611cb8542f8cd1d85945f61190 100644 (file)
--- a/lib/public/ieventsource.php
+++ b/lib/public/ieventsource.php
@@ -13,6 +13,8 @@ namespace OCP;
  * includes a fallback for older browsers and IE
  *
  * 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
  */
 interface IEventSource {
        /**

diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php
index 24d8894d9fe0d79e943a542ad6c5ac7a4ddeff3e..1abf0d9938d10b31fd01e14c490f5996704a0445 100644 (file)
--- a/lib/public/iservercontainer.php
+++ b/lib/public/iservercontainer.php
@@ -237,9 +237,9 @@ interface IServerContainer {
        function getCertificateManager($user = null);
        
        /**
-        * Returns a search instance
+        * Create a new event source
         *
         * @return \OCP\IEventSource
         */
-       function getEventSource();
+       function createEventSource();
 }