nextcloud / server

lib/private/Search.php

Indentation +86 added lines, -86 removed lines

@@ -34,97 +34,97 @@
  */
 class Search implements ISearch {
 
-	private $providers = array();
-	private $registeredProviders = array();
+    private $providers = array();
+    private $registeredProviders = array();
 
-	/**
-	 * Search all providers for $query
-	 * @param string $query
-	 * @param string[] $inApps optionally limit results to the given apps
-	 * @return array An array of OC\Search\Result's
-	 */
-	public function search($query, array $inApps = array()) {
-		// old apps might assume they get all results, so we set size 0
-		return $this->searchPaged($query, $inApps, 1, 0);
-	}
+    /**
+     * Search all providers for $query
+     * @param string $query
+     * @param string[] $inApps optionally limit results to the given apps
+     * @return array An array of OC\Search\Result's
+     */
+    public function search($query, array $inApps = array()) {
+        // old apps might assume they get all results, so we set size 0
+        return $this->searchPaged($query, $inApps, 1, 0);
+    }
 
-	/**
-	 * Search all providers for $query
-	 * @param string $query
-	 * @param string[] $inApps optionally limit results to the given apps
-	 * @param int $page pages start at page 1
-	 * @param int $size, 0 = all
-	 * @return array An array of OC\Search\Result's
-	 */
-	public function searchPaged($query, array $inApps = array(), $page = 1, $size = 30) {
-		$this->initProviders();
-		$results = array();
-		foreach($this->providers as $provider) {
-			/** @var $provider Provider */
-			if ( ! $provider->providesResultsFor($inApps) ) {
-				continue;
-			}
-			if ($provider instanceof PagedProvider) {
-				$results = array_merge($results, $provider->searchPaged($query, $page, $size));
-			} else if ($provider instanceof Provider) {
-				$providerResults = $provider->search($query);
-				if ($size > 0) {
-					$slicedResults = array_slice($providerResults, ($page - 1) * $size, $size);
-					$results = array_merge($results, $slicedResults);
-				} else {
-					$results = array_merge($results, $providerResults);
-				}
-			} else {
-				\OC::$server->getLogger()->warning('Ignoring Unknown search provider', array('provider' => $provider));
-			}
-		}
-		return $results;
-	}
+    /**
+     * Search all providers for $query
+     * @param string $query
+     * @param string[] $inApps optionally limit results to the given apps
+     * @param int $page pages start at page 1
+     * @param int $size, 0 = all
+     * @return array An array of OC\Search\Result's
+     */
+    public function searchPaged($query, array $inApps = array(), $page = 1, $size = 30) {
+        $this->initProviders();
+        $results = array();
+        foreach($this->providers as $provider) {
+            /** @var $provider Provider */
+            if ( ! $provider->providesResultsFor($inApps) ) {
+                continue;
+            }
+            if ($provider instanceof PagedProvider) {
+                $results = array_merge($results, $provider->searchPaged($query, $page, $size));
+            } else if ($provider instanceof Provider) {
+                $providerResults = $provider->search($query);
+                if ($size > 0) {
+                    $slicedResults = array_slice($providerResults, ($page - 1) * $size, $size);
+                    $results = array_merge($results, $slicedResults);
+                } else {
+                    $results = array_merge($results, $providerResults);
+                }
+            } else {
+                \OC::$server->getLogger()->warning('Ignoring Unknown search provider', array('provider' => $provider));
+            }
+        }
+        return $results;
+    }
 
-	/**
-	 * Remove all registered search providers
-	 */
-	public function clearProviders() {
-		$this->providers = array();
-		$this->registeredProviders = array();
-	}
+    /**
+     * Remove all registered search providers
+     */
+    public function clearProviders() {
+        $this->providers = array();
+        $this->registeredProviders = array();
+    }
 
-	/**
-	 * Remove one existing search provider
-	 * @param string $provider class name of a OC\Search\Provider
-	 */
-	public function removeProvider($provider) {
-		$this->registeredProviders = array_filter(
-			$this->registeredProviders,
-			function ($element) use ($provider) {
-				return ($element['class'] != $provider);
-			}
-		);
-		// force regeneration of providers on next search
-		$this->providers = array();
-	}
+    /**
+     * Remove one existing search provider
+     * @param string $provider class name of a OC\Search\Provider
+     */
+    public function removeProvider($provider) {
+        $this->registeredProviders = array_filter(
+            $this->registeredProviders,
+            function ($element) use ($provider) {
+                return ($element['class'] != $provider);
+            }
+        );
+        // force regeneration of providers on next search
+        $this->providers = array();
+    }
 
-	/**
-	 * Register a new search provider to search with
-	 * @param string $class class name of a OC\Search\Provider
-	 * @param array $options optional
-	 */
-	public function registerProvider($class, array $options = array()) {
-		$this->registeredProviders[] = array('class' => $class, 'options' => $options);
-	}
+    /**
+     * Register a new search provider to search with
+     * @param string $class class name of a OC\Search\Provider
+     * @param array $options optional
+     */
+    public function registerProvider($class, array $options = array()) {
+        $this->registeredProviders[] = array('class' => $class, 'options' => $options);
+    }
 
-	/**
-	 * Create instances of all the registered search providers
-	 */
-	private function initProviders() {
-		if( ! empty($this->providers) ) {
-			return;
-		}
-		foreach($this->registeredProviders as $provider) {
-			$class = $provider['class'];
-			$options = $provider['options'];
-			$this->providers[] = new $class($options);
-		}
-	}
+    /**
+     * Create instances of all the registered search providers
+     */
+    private function initProviders() {
+        if( ! empty($this->providers) ) {
+            return;
+        }
+        foreach($this->registeredProviders as $provider) {
+            $class = $provider['class'];
+            $options = $provider['options'];
+            $this->providers[] = new $class($options);
+        }
+    }
 
 }

lib/private/Http/Client/Response.php

Indentation +41 added lines, -41 removed lines

@@ -32,51 +32,51 @@
  * @package OC\Http
  */
 class Response implements IResponse {
-	/** @var GuzzleResponse */
-	private $response;
+    /** @var GuzzleResponse */
+    private $response;
 
-	/**
-	 * @var bool
-	 */
-	private $stream;
+    /**
+     * @var bool
+     */
+    private $stream;
 
-	/**
-	 * @param GuzzleResponse $response
-	 * @param bool $stream
-	 */
-	public function __construct(GuzzleResponse $response, $stream = false) {
-		$this->response = $response;
-		$this->stream = $stream;
-	}
+    /**
+     * @param GuzzleResponse $response
+     * @param bool $stream
+     */
+    public function __construct(GuzzleResponse $response, $stream = false) {
+        $this->response = $response;
+        $this->stream = $stream;
+    }
 
-	/**
-	 * @return string|resource
-	 */
-	public function getBody() {
-		return $this->stream ?
-			$this->response->getBody()->detach():
-			$this->response->getBody()->getContents();
-	}
+    /**
+     * @return string|resource
+     */
+    public function getBody() {
+        return $this->stream ?
+            $this->response->getBody()->detach():
+            $this->response->getBody()->getContents();
+    }
 
-	/**
-	 * @return int
-	 */
-	public function getStatusCode() {
-		return $this->response->getStatusCode();
-	}
+    /**
+     * @return int
+     */
+    public function getStatusCode() {
+        return $this->response->getStatusCode();
+    }
 
-	/**
-	 * @param $key
-	 * @return string
-	 */
-	public function getHeader($key) {
-		return $this->response->getHeader($key);
-	}
+    /**
+     * @param $key
+     * @return string
+     */
+    public function getHeader($key) {
+        return $this->response->getHeader($key);
+    }
 
-	/**
-	 * @return array
-	 */
-	public function getHeaders() {
-		return $this->response->getHeaders();
-	}
+    /**
+     * @return array
+     */
+    public function getHeaders() {
+        return $this->response->getHeaders();
+    }
 }

lib/private/Http/Client/Client.php

Indentation +263 added lines, -263 removed lines

@@ -34,280 +34,280 @@
  * @package OC\Http
  */
 class Client implements IClient {
-	/** @var GuzzleClient */
-	private $client;
-	/** @var IConfig */
-	private $config;
-	/** @var ICertificateManager */
-	private $certificateManager;
-	private $configured = false;
+    /** @var GuzzleClient */
+    private $client;
+    /** @var IConfig */
+    private $config;
+    /** @var ICertificateManager */
+    private $certificateManager;
+    private $configured = false;
 
-	/**
-	 * @param IConfig $config
-	 * @param ICertificateManager $certificateManager
-	 * @param GuzzleClient $client
-	 */
-	public function __construct(IConfig $config,
-								ICertificateManager $certificateManager,
-								GuzzleClient $client) {
-		$this->config = $config;
-		$this->client = $client;
-		$this->certificateManager = $certificateManager;
-	}
+    /**
+     * @param IConfig $config
+     * @param ICertificateManager $certificateManager
+     * @param GuzzleClient $client
+     */
+    public function __construct(IConfig $config,
+                                ICertificateManager $certificateManager,
+                                GuzzleClient $client) {
+        $this->config = $config;
+        $this->client = $client;
+        $this->certificateManager = $certificateManager;
+    }
 
-	/**
-	 * Sets the default options to the client
-	 */
-	private function setDefaultOptions() {
-		if ($this->configured) {
-			return;
-		}
-		$this->configured = true;
-		// Either use user bundle or the system bundle if nothing is specified
-		if ($this->certificateManager->listCertificates() !== []) {
-			$this->client->setDefaultOption('verify', $this->certificateManager->getAbsoluteBundlePath());
-		} else {
-			// If the instance is not yet setup we need to use the static path as
-			// $this->certificateManager->getAbsoluteBundlePath() tries to instantiiate
-			// a view
-			if ($this->config->getSystemValue('installed', false)) {
-				$this->client->setDefaultOption('verify', $this->certificateManager->getAbsoluteBundlePath(null));
-			} else {
-				$this->client->setDefaultOption('verify', \OC::$SERVERROOT . '/resources/config/ca-bundle.crt');
-			}
-		}
+    /**
+     * Sets the default options to the client
+     */
+    private function setDefaultOptions() {
+        if ($this->configured) {
+            return;
+        }
+        $this->configured = true;
+        // Either use user bundle or the system bundle if nothing is specified
+        if ($this->certificateManager->listCertificates() !== []) {
+            $this->client->setDefaultOption('verify', $this->certificateManager->getAbsoluteBundlePath());
+        } else {
+            // If the instance is not yet setup we need to use the static path as
+            // $this->certificateManager->getAbsoluteBundlePath() tries to instantiiate
+            // a view
+            if ($this->config->getSystemValue('installed', false)) {
+                $this->client->setDefaultOption('verify', $this->certificateManager->getAbsoluteBundlePath(null));
+            } else {
+                $this->client->setDefaultOption('verify', \OC::$SERVERROOT . '/resources/config/ca-bundle.crt');
+            }
+        }
 
-		$this->client->setDefaultOption('headers/User-Agent', 'Nextcloud Server Crawler');
-		$proxyUri = $this->getProxyUri();
-		if ($proxyUri !== '') {
-			$this->client->setDefaultOption('proxy', $proxyUri);
-		}
-	}
+        $this->client->setDefaultOption('headers/User-Agent', 'Nextcloud Server Crawler');
+        $proxyUri = $this->getProxyUri();
+        if ($proxyUri !== '') {
+            $this->client->setDefaultOption('proxy', $proxyUri);
+        }
+    }
 
-	/**
-	 * Get the proxy URI
-	 *
-	 * @return string
-	 */
-	private function getProxyUri() {
-		$proxyHost = $this->config->getSystemValue('proxy', null);
-		$proxyUserPwd = $this->config->getSystemValue('proxyuserpwd', null);
-		$proxyUri = '';
+    /**
+     * Get the proxy URI
+     *
+     * @return string
+     */
+    private function getProxyUri() {
+        $proxyHost = $this->config->getSystemValue('proxy', null);
+        $proxyUserPwd = $this->config->getSystemValue('proxyuserpwd', null);
+        $proxyUri = '';
 
-		if ($proxyUserPwd !== null) {
-			$proxyUri .= $proxyUserPwd . '@';
-		}
-		if ($proxyHost !== null) {
-			$proxyUri .= $proxyHost;
-		}
+        if ($proxyUserPwd !== null) {
+            $proxyUri .= $proxyUserPwd . '@';
+        }
+        if ($proxyHost !== null) {
+            $proxyUri .= $proxyHost;
+        }
 
-		return $proxyUri;
-	}
+        return $proxyUri;
+    }
 
-	/**
-	 * Sends a GET request
-	 *
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'query' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 *              'timeout' => 5,
-	 * @return Response
-	 * @throws \Exception If the request could not get completed
-	 */
-	public function get($uri, array $options = []) {
-		$this->setDefaultOptions();
-		$response = $this->client->get($uri, $options);
-		$isStream = isset($options['stream']) && $options['stream'];
-		return new Response($response, $isStream);
-	}
+    /**
+     * Sends a GET request
+     *
+     * @param string $uri
+     * @param array $options Array such as
+     *              'query' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     *              'timeout' => 5,
+     * @return Response
+     * @throws \Exception If the request could not get completed
+     */
+    public function get($uri, array $options = []) {
+        $this->setDefaultOptions();
+        $response = $this->client->get($uri, $options);
+        $isStream = isset($options['stream']) && $options['stream'];
+        return new Response($response, $isStream);
+    }
 
-	/**
-	 * Sends a HEAD request
-	 *
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 *              'timeout' => 5,
-	 * @return Response
-	 * @throws \Exception If the request could not get completed
-	 */
-	public function head($uri, $options = []) {
-		$this->setDefaultOptions();
-		$response = $this->client->head($uri, $options);
-		return new Response($response);
-	}
+    /**
+     * Sends a HEAD request
+     *
+     * @param string $uri
+     * @param array $options Array such as
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     *              'timeout' => 5,
+     * @return Response
+     * @throws \Exception If the request could not get completed
+     */
+    public function head($uri, $options = []) {
+        $this->setDefaultOptions();
+        $response = $this->client->head($uri, $options);
+        return new Response($response);
+    }
 
-	/**
-	 * Sends a POST request
-	 *
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'body' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 *              'timeout' => 5,
-	 * @return Response
-	 * @throws \Exception If the request could not get completed
-	 */
-	public function post($uri, array $options = []) {
-		$this->setDefaultOptions();
-		$response = $this->client->post($uri, $options);
-		return new Response($response);
-	}
+    /**
+     * Sends a POST request
+     *
+     * @param string $uri
+     * @param array $options Array such as
+     *              'body' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     *              'timeout' => 5,
+     * @return Response
+     * @throws \Exception If the request could not get completed
+     */
+    public function post($uri, array $options = []) {
+        $this->setDefaultOptions();
+        $response = $this->client->post($uri, $options);
+        return new Response($response);
+    }
 
-	/**
-	 * Sends a PUT request
-	 *
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'body' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 *              'timeout' => 5,
-	 * @return Response
-	 * @throws \Exception If the request could not get completed
-	 */
-	public function put($uri, array $options = []) {
-		$this->setDefaultOptions();
-		$response = $this->client->put($uri, $options);
-		return new Response($response);
-	}
+    /**
+     * Sends a PUT request
+     *
+     * @param string $uri
+     * @param array $options Array such as
+     *              'body' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     *              'timeout' => 5,
+     * @return Response
+     * @throws \Exception If the request could not get completed
+     */
+    public function put($uri, array $options = []) {
+        $this->setDefaultOptions();
+        $response = $this->client->put($uri, $options);
+        return new Response($response);
+    }
 
-	/**
-	 * Sends a DELETE request
-	 *
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'body' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 *              'timeout' => 5,
-	 * @return Response
-	 * @throws \Exception If the request could not get completed
-	 */
-	public function delete($uri, array $options = []) {
-		$this->setDefaultOptions();
-		$response = $this->client->delete($uri, $options);
-		return new Response($response);
-	}
+    /**
+     * Sends a DELETE request
+     *
+     * @param string $uri
+     * @param array $options Array such as
+     *              'body' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     *              'timeout' => 5,
+     * @return Response
+     * @throws \Exception If the request could not get completed
+     */
+    public function delete($uri, array $options = []) {
+        $this->setDefaultOptions();
+        $response = $this->client->delete($uri, $options);
+        return new Response($response);
+    }
 
 
-	/**
-	 * Sends a options request
-	 *
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'body' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 *              'timeout' => 5,
-	 * @return Response
-	 * @throws \Exception If the request could not get completed
-	 */
-	public function options($uri, array $options = []) {
-		$this->setDefaultOptions();
-		$response = $this->client->options($uri, $options);
-		return new Response($response);
-	}
+    /**
+     * Sends a options request
+     *
+     * @param string $uri
+     * @param array $options Array such as
+     *              'body' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     *              'timeout' => 5,
+     * @return Response
+     * @throws \Exception If the request could not get completed
+     */
+    public function options($uri, array $options = []) {
+        $this->setDefaultOptions();
+        $response = $this->client->options($uri, $options);
+        return new Response($response);
+    }
 }

lib/private/Http/Client/ClientService.php

Indentation +19 added lines, -19 removed lines

@@ -33,25 +33,25 @@
  * @package OC\Http
  */
 class ClientService implements IClientService {
-	/** @var IConfig */
-	private $config;
-	/** @var ICertificateManager */
-	private $certificateManager;
+    /** @var IConfig */
+    private $config;
+    /** @var ICertificateManager */
+    private $certificateManager;
 
-	/**
-	 * @param IConfig $config
-	 * @param ICertificateManager $certificateManager
-	 */
-	public function __construct(IConfig $config,
-								ICertificateManager $certificateManager) {
-		$this->config = $config;
-		$this->certificateManager = $certificateManager;
-	}
+    /**
+     * @param IConfig $config
+     * @param ICertificateManager $certificateManager
+     */
+    public function __construct(IConfig $config,
+                                ICertificateManager $certificateManager) {
+        $this->config = $config;
+        $this->certificateManager = $certificateManager;
+    }
 
-	/**
-	 * @return Client
-	 */
-	public function newClient() {
-		return new Client($this->config, $this->certificateManager, new GuzzleClient());
-	}
+    /**
+     * @return Client
+     */
+    public function newClient() {
+        return new Client($this->config, $this->certificateManager, new GuzzleClient());
+    }
 }

lib/private/Session/Memory.php

Indentation +72 added lines, -72 removed lines

@@ -38,86 +38,86 @@
  * @package OC\Session
  */
 class Memory extends Session {
-	protected $data;
+    protected $data;
 
-	public function __construct($name) {
-		//no need to use $name since all data is already scoped to this instance
-		$this->data = array();
-	}
+    public function __construct($name) {
+        //no need to use $name since all data is already scoped to this instance
+        $this->data = array();
+    }
 
-	/**
-	 * @param string $key
-	 * @param integer $value
-	 */
-	public function set($key, $value) {
-		$this->validateSession();
-		$this->data[$key] = $value;
-	}
+    /**
+     * @param string $key
+     * @param integer $value
+     */
+    public function set($key, $value) {
+        $this->validateSession();
+        $this->data[$key] = $value;
+    }
 
-	/**
-	 * @param string $key
-	 * @return mixed
-	 */
-	public function get($key) {
-		if (!$this->exists($key)) {
-			return null;
-		}
-		return $this->data[$key];
-	}
+    /**
+     * @param string $key
+     * @return mixed
+     */
+    public function get($key) {
+        if (!$this->exists($key)) {
+            return null;
+        }
+        return $this->data[$key];
+    }
 
-	/**
-	 * @param string $key
-	 * @return bool
-	 */
-	public function exists($key) {
-		return isset($this->data[$key]);
-	}
+    /**
+     * @param string $key
+     * @return bool
+     */
+    public function exists($key) {
+        return isset($this->data[$key]);
+    }
 
-	/**
-	 * @param string $key
-	 */
-	public function remove($key) {
-		$this->validateSession();
-		unset($this->data[$key]);
-	}
+    /**
+     * @param string $key
+     */
+    public function remove($key) {
+        $this->validateSession();
+        unset($this->data[$key]);
+    }
 
-	public function clear() {
-		$this->data = array();
-	}
+    public function clear() {
+        $this->data = array();
+    }
 
-	/**
-	 * Stub since the session ID does not need to get regenerated for the cache
-	 *
-	 * @param bool $deleteOldSession
-	 */
-	public function regenerateId($deleteOldSession = true) {}
+    /**
+     * Stub since the session ID does not need to get regenerated for the cache
+     *
+     * @param bool $deleteOldSession
+     */
+    public function regenerateId($deleteOldSession = true) {}
 
-	/**
-	 * Wrapper around session_id
-	 *
-	 * @return string
-	 * @throws SessionNotAvailableException
-	 * @since 9.1.0
-	 */
-	public function getId() {
-		throw new SessionNotAvailableException('Memory session does not have an ID');
-	}
+    /**
+     * Wrapper around session_id
+     *
+     * @return string
+     * @throws SessionNotAvailableException
+     * @since 9.1.0
+     */
+    public function getId() {
+        throw new SessionNotAvailableException('Memory session does not have an ID');
+    }
 
-	/**
-	 * Helper function for PHPUnit execution - don't use in non-test code
-	 */
-	public function reopen() {
-		$this->sessionClosed = false;
-	}
+    /**
+     * Helper function for PHPUnit execution - don't use in non-test code
+     */
+    public function reopen() {
+        $this->sessionClosed = false;
+    }
 
-	/**
-	 * In case the session has already been locked an exception will be thrown
-	 *
-	 * @throws Exception
-	 */
-	private function validateSession() {
-		if ($this->sessionClosed) {
-			throw new Exception('Session has been closed - no further changes to the session are allowed');
-		}
-	}
+    /**
+     * In case the session has already been locked an exception will be thrown
+     *
+     * @throws Exception
+     */
+    private function validateSession() {
+        if ($this->sessionClosed) {
+            throw new Exception('Session has been closed - no further changes to the session are allowed');
+        }
+    }
 }

lib/private/Session/Session.php

Indentation +43 added lines, -43 removed lines

@@ -28,53 +28,53 @@
 
 abstract class Session implements \ArrayAccess, ISession {
 
-	/**
-	 * @var bool
-	 */
-	protected $sessionClosed = false;
+    /**
+     * @var bool
+     */
+    protected $sessionClosed = false;
 
-	/**
-	 * $name serves as a namespace for the session keys
-	 *
-	 * @param string $name
-	 */
-	abstract public function __construct($name);
+    /**
+     * $name serves as a namespace for the session keys
+     *
+     * @param string $name
+     */
+    abstract public function __construct($name);
 
-	/**
-	 * @param mixed $offset
-	 * @return bool
-	 */
-	public function offsetExists($offset) {
-		return $this->exists($offset);
-	}
+    /**
+     * @param mixed $offset
+     * @return bool
+     */
+    public function offsetExists($offset) {
+        return $this->exists($offset);
+    }
 
-	/**
-	 * @param mixed $offset
-	 * @return mixed
-	 */
-	public function offsetGet($offset) {
-		return $this->get($offset);
-	}
+    /**
+     * @param mixed $offset
+     * @return mixed
+     */
+    public function offsetGet($offset) {
+        return $this->get($offset);
+    }
 
-	/**
-	 * @param mixed $offset
-	 * @param mixed $value
-	 */
-	public function offsetSet($offset, $value) {
-		$this->set($offset, $value);
-	}
+    /**
+     * @param mixed $offset
+     * @param mixed $value
+     */
+    public function offsetSet($offset, $value) {
+        $this->set($offset, $value);
+    }
 
-	/**
-	 * @param mixed $offset
-	 */
-	public function offsetUnset($offset) {
-		$this->remove($offset);
-	}
+    /**
+     * @param mixed $offset
+     */
+    public function offsetUnset($offset) {
+        $this->remove($offset);
+    }
 
-	/**
-	 * Close the session and release the lock
-	 */
-	public function close() {
-		$this->sessionClosed = true;
-	}
+    /**
+     * Close the session and release the lock
+     */
+    public function close() {
+        $this->sessionClosed = true;
+    }
 }

lib/private/Comments/Comment.php

Indentation +389 added lines, -389 removed lines

@@ -29,393 +29,393 @@
 
 class Comment implements IComment {
 
-	protected $data = [
-		'id'              => '',
-		'parentId'        => '0',
-		'topmostParentId' => '0',
-		'childrenCount'   => '0',
-		'message'         => '',
-		'verb'            => '',
-		'actorType'       => '',
-		'actorId'         => '',
-		'objectType'      => '',
-		'objectId'        => '',
-		'creationDT'      => null,
-		'latestChildDT'   => null,
-	];
-
-	/**
-	 * Comment constructor.
-	 *
-	 * @param array $data	optional, array with keys according to column names from
-	 * 						the comments database scheme
-	 */
-	public function __construct(array $data = null) {
-		if(is_array($data)) {
-			$this->fromArray($data);
-		}
-	}
-
-	/**
-	 * returns the ID of the comment
-	 *
-	 * It may return an empty string, if the comment was not stored.
-	 * It is expected that the concrete Comment implementation gives an ID
-	 * by itself (e.g. after saving).
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getId() {
-		return $this->data['id'];
-	}
-
-	/**
-	 * sets the ID of the comment and returns itself
-	 *
-	 * It is only allowed to set the ID only, if the current id is an empty
-	 * string (which means it is not stored in a database, storage or whatever
-	 * the concrete implementation does), or vice versa. Changing a given ID is
-	 * not permitted and must result in an IllegalIDChangeException.
-	 *
-	 * @param string $id
-	 * @return IComment
-	 * @throws IllegalIDChangeException
-	 * @since 9.0.0
-	 */
-	public function setId($id) {
-		if(!is_string($id)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-
-		$id = trim($id);
-		if($this->data['id'] === '' || ($this->data['id'] !== '' && $id === '')) {
-			$this->data['id'] = $id;
-			return $this;
-		}
-
-		throw new IllegalIDChangeException('Not allowed to assign a new ID to an already saved comment.');
-	}
-
-	/**
-	 * returns the parent ID of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getParentId() {
-		return $this->data['parentId'];
-	}
-
-	/**
-	 * sets the parent ID and returns itself
-	 *
-	 * @param string $parentId
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setParentId($parentId) {
-		if(!is_string($parentId)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$this->data['parentId'] = trim($parentId);
-		return $this;
-	}
-
-	/**
-	 * returns the topmost parent ID of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getTopmostParentId() {
-		return $this->data['topmostParentId'];
-	}
-
-
-	/**
-	 * sets the topmost parent ID and returns itself
-	 *
-	 * @param string $id
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setTopmostParentId($id) {
-		if(!is_string($id)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$this->data['topmostParentId'] = trim($id);
-		return $this;
-	}
-
-	/**
-	 * returns the number of children
-	 *
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getChildrenCount() {
-		return $this->data['childrenCount'];
-	}
-
-	/**
-	 * sets the number of children
-	 *
-	 * @param int $count
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setChildrenCount($count) {
-		if(!is_int($count)) {
-			throw new \InvalidArgumentException('Integer expected.');
-		}
-		$this->data['childrenCount'] = $count;
-		return $this;
-	}
-
-	/**
-	 * returns the message of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getMessage() {
-		return $this->data['message'];
-	}
-
-	/**
-	 * sets the message of the comment and returns itself
-	 *
-	 * @param string $message
-	 * @return IComment
-	 * @throws MessageTooLongException
-	 * @since 9.0.0
-	 */
-	public function setMessage($message) {
-		if(!is_string($message)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$message = trim($message);
-		if(mb_strlen($message, 'UTF-8') > IComment::MAX_MESSAGE_LENGTH) {
-			throw new MessageTooLongException('Comment message must not exceed ' . IComment::MAX_MESSAGE_LENGTH . ' characters');
-		}
-		$this->data['message'] = $message;
-		return $this;
-	}
-
-	/**
-	 * returns an array containing mentions that are included in the comment
-	 *
-	 * @return array each mention provides a 'type' and an 'id', see example below
-	 * @since 11.0.0
-	 *
-	 * The return array looks like:
-	 * [
-	 *   [
-	 *     'type' => 'user',
-	 *     'id' => 'citizen4'
-	 *   ],
-	 *   [
-	 *     'type' => 'group',
-	 *     'id' => 'media'
-	 *   ],
-	 *   …
-	 * ]
-	 *
-	 */
-	public function getMentions() {
-		$ok = preg_match_all('/\B@[a-z0-9_\-@\.\']+/i', $this->getMessage(), $mentions);
-		if(!$ok || !isset($mentions[0]) || !is_array($mentions[0])) {
-			return [];
-		}
-		$uids = array_unique($mentions[0]);
-		$result = [];
-		foreach ($uids as $uid) {
-			// exclude author, no self-mentioning
-			if($uid === '@' . $this->getActorId()) {
-				continue;
-			}
-			$result[] = ['type' => 'user', 'id' => substr($uid, 1)];
-		}
-		return $result;
-	}
-
-	/**
-	 * returns the verb of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getVerb() {
-		return $this->data['verb'];
-	}
-
-	/**
-	 * sets the verb of the comment, e.g. 'comment' or 'like'
-	 *
-	 * @param string $verb
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setVerb($verb) {
-		if(!is_string($verb) || !trim($verb)) {
-			throw new \InvalidArgumentException('Non-empty String expected.');
-		}
-		$this->data['verb'] = trim($verb);
-		return $this;
-	}
-
-	/**
-	 * returns the actor type
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getActorType() {
-		return $this->data['actorType'];
-	}
-
-	/**
-	 * returns the actor ID
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getActorId() {
-		return $this->data['actorId'];
-	}
-
-	/**
-	 * sets (overwrites) the actor type and id
-	 *
-	 * @param string $actorType e.g. 'users'
-	 * @param string $actorId e.g. 'zombie234'
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setActor($actorType, $actorId) {
-		if(
-		       !is_string($actorType) || !trim($actorType)
-		    || !is_string($actorId)   || !trim($actorId)
-		) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$this->data['actorType'] = trim($actorType);
-		$this->data['actorId']   = trim($actorId);
-		return $this;
-	}
-
-	/**
-	 * returns the creation date of the comment.
-	 *
-	 * If not explicitly set, it shall default to the time of initialization.
-	 *
-	 * @return \DateTime
-	 * @since 9.0.0
-	 */
-	public function getCreationDateTime() {
-		return $this->data['creationDT'];
-	}
-
-	/**
-	 * sets the creation date of the comment and returns itself
-	 *
-	 * @param \DateTime $timestamp
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setCreationDateTime(\DateTime $timestamp) {
-		$this->data['creationDT'] = $timestamp;
-		return $this;
-	}
-
-	/**
-	 * returns the DateTime of the most recent child, if set, otherwise null
-	 *
-	 * @return \DateTime|null
-	 * @since 9.0.0
-	 */
-	public function getLatestChildDateTime() {
-		return $this->data['latestChildDT'];
-	}
-
-	/**
-	 * sets the date of the most recent child
-	 *
-	 * @param \DateTime $dateTime
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setLatestChildDateTime(\DateTime $dateTime = null) {
-		$this->data['latestChildDT'] = $dateTime;
-		return $this;
-	}
-
-	/**
-	 * returns the object type the comment is attached to
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getObjectType() {
-		return $this->data['objectType'];
-	}
-
-	/**
-	 * returns the object id the comment is attached to
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getObjectId() {
-		return $this->data['objectId'];
-	}
-
-	/**
-	 * sets (overwrites) the object of the comment
-	 *
-	 * @param string $objectType e.g. 'files'
-	 * @param string $objectId e.g. '16435'
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setObject($objectType, $objectId) {
-		if(
-		       !is_string($objectType) || !trim($objectType)
-		    || !is_string($objectId)   || !trim($objectId)
-		) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$this->data['objectType'] = trim($objectType);
-		$this->data['objectId']   = trim($objectId);
-		return $this;
-	}
-
-	/**
-	 * sets the comment data based on an array with keys as taken from the
-	 * database.
-	 *
-	 * @param array $data
-	 * @return IComment
-	 */
-	protected function fromArray($data) {
-		foreach(array_keys($data) as $key) {
-			// translate DB keys to internal setter names
-			$setter = 'set' . implode('', array_map('ucfirst', explode('_', $key)));
-			$setter = str_replace('Timestamp', 'DateTime', $setter);
-
-			if(method_exists($this, $setter)) {
-				$this->$setter($data[$key]);
-			}
-		}
-
-		foreach(['actor', 'object'] as $role) {
-			if(isset($data[$role . '_type']) && isset($data[$role . '_id'])) {
-				$setter = 'set' . ucfirst($role);
-				$this->$setter($data[$role . '_type'], $data[$role . '_id']);
-			}
-		}
-
-		return $this;
-	}
+    protected $data = [
+        'id'              => '',
+        'parentId'        => '0',
+        'topmostParentId' => '0',
+        'childrenCount'   => '0',
+        'message'         => '',
+        'verb'            => '',
+        'actorType'       => '',
+        'actorId'         => '',
+        'objectType'      => '',
+        'objectId'        => '',
+        'creationDT'      => null,
+        'latestChildDT'   => null,
+    ];
+
+    /**
+     * Comment constructor.
+     *
+     * @param array $data	optional, array with keys according to column names from
+     * 						the comments database scheme
+     */
+    public function __construct(array $data = null) {
+        if(is_array($data)) {
+            $this->fromArray($data);
+        }
+    }
+
+    /**
+     * returns the ID of the comment
+     *
+     * It may return an empty string, if the comment was not stored.
+     * It is expected that the concrete Comment implementation gives an ID
+     * by itself (e.g. after saving).
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getId() {
+        return $this->data['id'];
+    }
+
+    /**
+     * sets the ID of the comment and returns itself
+     *
+     * It is only allowed to set the ID only, if the current id is an empty
+     * string (which means it is not stored in a database, storage or whatever
+     * the concrete implementation does), or vice versa. Changing a given ID is
+     * not permitted and must result in an IllegalIDChangeException.
+     *
+     * @param string $id
+     * @return IComment
+     * @throws IllegalIDChangeException
+     * @since 9.0.0
+     */
+    public function setId($id) {
+        if(!is_string($id)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+
+        $id = trim($id);
+        if($this->data['id'] === '' || ($this->data['id'] !== '' && $id === '')) {
+            $this->data['id'] = $id;
+            return $this;
+        }
+
+        throw new IllegalIDChangeException('Not allowed to assign a new ID to an already saved comment.');
+    }
+
+    /**
+     * returns the parent ID of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getParentId() {
+        return $this->data['parentId'];
+    }
+
+    /**
+     * sets the parent ID and returns itself
+     *
+     * @param string $parentId
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setParentId($parentId) {
+        if(!is_string($parentId)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $this->data['parentId'] = trim($parentId);
+        return $this;
+    }
+
+    /**
+     * returns the topmost parent ID of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getTopmostParentId() {
+        return $this->data['topmostParentId'];
+    }
+
+
+    /**
+     * sets the topmost parent ID and returns itself
+     *
+     * @param string $id
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setTopmostParentId($id) {
+        if(!is_string($id)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $this->data['topmostParentId'] = trim($id);
+        return $this;
+    }
+
+    /**
+     * returns the number of children
+     *
+     * @return int
+     * @since 9.0.0
+     */
+    public function getChildrenCount() {
+        return $this->data['childrenCount'];
+    }
+
+    /**
+     * sets the number of children
+     *
+     * @param int $count
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setChildrenCount($count) {
+        if(!is_int($count)) {
+            throw new \InvalidArgumentException('Integer expected.');
+        }
+        $this->data['childrenCount'] = $count;
+        return $this;
+    }
+
+    /**
+     * returns the message of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getMessage() {
+        return $this->data['message'];
+    }
+
+    /**
+     * sets the message of the comment and returns itself
+     *
+     * @param string $message
+     * @return IComment
+     * @throws MessageTooLongException
+     * @since 9.0.0
+     */
+    public function setMessage($message) {
+        if(!is_string($message)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $message = trim($message);
+        if(mb_strlen($message, 'UTF-8') > IComment::MAX_MESSAGE_LENGTH) {
+            throw new MessageTooLongException('Comment message must not exceed ' . IComment::MAX_MESSAGE_LENGTH . ' characters');
+        }
+        $this->data['message'] = $message;
+        return $this;
+    }
+
+    /**
+     * returns an array containing mentions that are included in the comment
+     *
+     * @return array each mention provides a 'type' and an 'id', see example below
+     * @since 11.0.0
+     *
+     * The return array looks like:
+     * [
+     *   [
+     *     'type' => 'user',
+     *     'id' => 'citizen4'
+     *   ],
+     *   [
+     *     'type' => 'group',
+     *     'id' => 'media'
+     *   ],
+     *   …
+     * ]
+     *
+     */
+    public function getMentions() {
+        $ok = preg_match_all('/\B@[a-z0-9_\-@\.\']+/i', $this->getMessage(), $mentions);
+        if(!$ok || !isset($mentions[0]) || !is_array($mentions[0])) {
+            return [];
+        }
+        $uids = array_unique($mentions[0]);
+        $result = [];
+        foreach ($uids as $uid) {
+            // exclude author, no self-mentioning
+            if($uid === '@' . $this->getActorId()) {
+                continue;
+            }
+            $result[] = ['type' => 'user', 'id' => substr($uid, 1)];
+        }
+        return $result;
+    }
+
+    /**
+     * returns the verb of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getVerb() {
+        return $this->data['verb'];
+    }
+
+    /**
+     * sets the verb of the comment, e.g. 'comment' or 'like'
+     *
+     * @param string $verb
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setVerb($verb) {
+        if(!is_string($verb) || !trim($verb)) {
+            throw new \InvalidArgumentException('Non-empty String expected.');
+        }
+        $this->data['verb'] = trim($verb);
+        return $this;
+    }
+
+    /**
+     * returns the actor type
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getActorType() {
+        return $this->data['actorType'];
+    }
+
+    /**
+     * returns the actor ID
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getActorId() {
+        return $this->data['actorId'];
+    }
+
+    /**
+     * sets (overwrites) the actor type and id
+     *
+     * @param string $actorType e.g. 'users'
+     * @param string $actorId e.g. 'zombie234'
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setActor($actorType, $actorId) {
+        if(
+                !is_string($actorType) || !trim($actorType)
+            || !is_string($actorId)   || !trim($actorId)
+        ) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $this->data['actorType'] = trim($actorType);
+        $this->data['actorId']   = trim($actorId);
+        return $this;
+    }
+
+    /**
+     * returns the creation date of the comment.
+     *
+     * If not explicitly set, it shall default to the time of initialization.
+     *
+     * @return \DateTime
+     * @since 9.0.0
+     */
+    public function getCreationDateTime() {
+        return $this->data['creationDT'];
+    }
+
+    /**
+     * sets the creation date of the comment and returns itself
+     *
+     * @param \DateTime $timestamp
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setCreationDateTime(\DateTime $timestamp) {
+        $this->data['creationDT'] = $timestamp;
+        return $this;
+    }
+
+    /**
+     * returns the DateTime of the most recent child, if set, otherwise null
+     *
+     * @return \DateTime|null
+     * @since 9.0.0
+     */
+    public function getLatestChildDateTime() {
+        return $this->data['latestChildDT'];
+    }
+
+    /**
+     * sets the date of the most recent child
+     *
+     * @param \DateTime $dateTime
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setLatestChildDateTime(\DateTime $dateTime = null) {
+        $this->data['latestChildDT'] = $dateTime;
+        return $this;
+    }
+
+    /**
+     * returns the object type the comment is attached to
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getObjectType() {
+        return $this->data['objectType'];
+    }
+
+    /**
+     * returns the object id the comment is attached to
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getObjectId() {
+        return $this->data['objectId'];
+    }
+
+    /**
+     * sets (overwrites) the object of the comment
+     *
+     * @param string $objectType e.g. 'files'
+     * @param string $objectId e.g. '16435'
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setObject($objectType, $objectId) {
+        if(
+                !is_string($objectType) || !trim($objectType)
+            || !is_string($objectId)   || !trim($objectId)
+        ) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $this->data['objectType'] = trim($objectType);
+        $this->data['objectId']   = trim($objectId);
+        return $this;
+    }
+
+    /**
+     * sets the comment data based on an array with keys as taken from the
+     * database.
+     *
+     * @param array $data
+     * @return IComment
+     */
+    protected function fromArray($data) {
+        foreach(array_keys($data) as $key) {
+            // translate DB keys to internal setter names
+            $setter = 'set' . implode('', array_map('ucfirst', explode('_', $key)));
+            $setter = str_replace('Timestamp', 'DateTime', $setter);
+
+            if(method_exists($this, $setter)) {
+                $this->$setter($data[$key]);
+            }
+        }
+
+        foreach(['actor', 'object'] as $role) {
+            if(isset($data[$role . '_type']) && isset($data[$role . '_id'])) {
+                $setter = 'set' . ucfirst($role);
+                $this->$setter($data[$role . '_type'], $data[$role . '_id']);
+            }
+        }
+
+        return $this;
+    }
 }

lib/private/Notification/Notification.php

Indentation +551 added lines, -551 removed lines

@@ -31,555 +31,555 @@
 
 class Notification implements INotification {
 
-	/** @var IValidator */
-	protected $richValidator;
-
-	/** @var string */
-	protected $app;
-
-	/** @var string */
-	protected $user;
-
-	/** @var \DateTime */
-	protected $dateTime;
-
-	/** @var string */
-	protected $objectType;
-
-	/** @var string */
-	protected $objectId;
-
-	/** @var string */
-	protected $subject;
-
-	/** @var array */
-	protected $subjectParameters;
-
-	/** @var string */
-	protected $subjectParsed;
-
-	/** @var string */
-	protected $subjectRich;
-
-	/** @var array */
-	protected $subjectRichParameters;
-
-	/** @var string */
-	protected $message;
-
-	/** @var array */
-	protected $messageParameters;
-
-	/** @var string */
-	protected $messageParsed;
-
-	/** @var string */
-	protected $messageRich;
-
-	/** @var array */
-	protected $messageRichParameters;
-
-	/** @var string */
-	protected $link;
-
-	/** @var string */
-	protected $icon;
-
-	/** @var array */
-	protected $actions;
-
-	/** @var array */
-	protected $actionsParsed;
-
-	/** @var bool */
-	protected $hasPrimaryAction;
-
-	/** @var bool */
-	protected $hasPrimaryParsedAction;
-
-	/**
-	 * Constructor
-	 *
-	 * @param IValidator $richValidator
-	 */
-	public function __construct(IValidator $richValidator) {
-		$this->richValidator = $richValidator;
-		$this->app = '';
-		$this->user = '';
-		$this->dateTime = new \DateTime();
-		$this->dateTime->setTimestamp(0);
-		$this->objectType = '';
-		$this->objectId = '';
-		$this->subject = '';
-		$this->subjectParameters = [];
-		$this->subjectParsed = '';
-		$this->subjectRich = '';
-		$this->subjectRichParameters = [];
-		$this->message = '';
-		$this->messageParameters = [];
-		$this->messageParsed = '';
-		$this->messageRich = '';
-		$this->messageRichParameters = [];
-		$this->link = '';
-		$this->icon = '';
-		$this->actions = [];
-		$this->actionsParsed = [];
-	}
-
-	/**
-	 * @param string $app
-	 * @return $this
-	 * @throws \InvalidArgumentException if the app id is invalid
-	 * @since 8.2.0
-	 */
-	public function setApp($app) {
-		if (!is_string($app) || $app === '' || isset($app[32])) {
-			throw new \InvalidArgumentException('The given app name is invalid');
-		}
-		$this->app = $app;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getApp() {
-		return $this->app;
-	}
-
-	/**
-	 * @param string $user
-	 * @return $this
-	 * @throws \InvalidArgumentException if the user id is invalid
-	 * @since 8.2.0
-	 */
-	public function setUser($user) {
-		if (!is_string($user) || $user === '' || isset($user[64])) {
-			throw new \InvalidArgumentException('The given user id is invalid');
-		}
-		$this->user = $user;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getUser() {
-		return $this->user;
-	}
-
-	/**
-	 * @param \DateTime $dateTime
-	 * @return $this
-	 * @throws \InvalidArgumentException if the $dateTime is invalid
-	 * @since 9.0.0
-	 */
-	public function setDateTime(\DateTime $dateTime) {
-		if ($dateTime->getTimestamp() === 0) {
-			throw new \InvalidArgumentException('The given date time is invalid');
-		}
-		$this->dateTime = $dateTime;
-		return $this;
-	}
-
-	/**
-	 * @return \DateTime
-	 * @since 9.0.0
-	 */
-	public function getDateTime() {
-		return $this->dateTime;
-	}
-
-	/**
-	 * @param string $type
-	 * @param string $id
-	 * @return $this
-	 * @throws \InvalidArgumentException if the object type or id is invalid
-	 * @since 8.2.0 - 9.0.0: Type of $id changed to string
-	 */
-	public function setObject($type, $id) {
-		if (!is_string($type) || $type === '' || isset($type[64])) {
-			throw new \InvalidArgumentException('The given object type is invalid');
-		}
-		$this->objectType = $type;
-
-		if (!is_int($id) && (!is_string($id) || $id === '' || isset($id[64]))) {
-			throw new \InvalidArgumentException('The given object id is invalid');
-		}
-		$this->objectId = (string) $id;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getObjectType() {
-		return $this->objectType;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0 - 9.0.0: Return type changed to string
-	 */
-	public function getObjectId() {
-		return $this->objectId;
-	}
-
-	/**
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setSubject($subject, array $parameters = []) {
-		if (!is_string($subject) || $subject === '' || isset($subject[64])) {
-			throw new \InvalidArgumentException('The given subject is invalid');
-		}
-
-		$this->subject = $subject;
-		$this->subjectParameters = $parameters;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getSubject() {
-		return $this->subject;
-	}
-
-	/**
-	 * @return string[]
-	 * @since 8.2.0
-	 */
-	public function getSubjectParameters() {
-		return $this->subjectParameters;
-	}
-
-	/**
-	 * @param string $subject
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject is invalid
-	 * @since 8.2.0
-	 */
-	public function setParsedSubject($subject) {
-		if (!is_string($subject) || $subject === '') {
-			throw new \InvalidArgumentException('The given parsed subject is invalid');
-		}
-		$this->subjectParsed = $subject;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getParsedSubject() {
-		return $this->subjectParsed;
-	}
-
-	/**
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 11.0.0
-	 */
-	public function setRichSubject($subject, array $parameters = []) {
-		if (!is_string($subject) || $subject === '') {
-			throw new \InvalidArgumentException('The given parsed subject is invalid');
-		}
-
-		$this->subjectRich = $subject;
-		$this->subjectRichParameters = $parameters;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichSubject() {
-		return $this->subjectRich;
-	}
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichSubjectParameters() {
-		return $this->subjectRichParameters;
-	}
-
-	/**
-	 * @param string $message
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setMessage($message, array $parameters = []) {
-		if (!is_string($message) || $message === '' || isset($message[64])) {
-			throw new \InvalidArgumentException('The given message is invalid');
-		}
-
-		$this->message = $message;
-		$this->messageParameters = $parameters;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getMessage() {
-		return $this->message;
-	}
-
-	/**
-	 * @return string[]
-	 * @since 8.2.0
-	 */
-	public function getMessageParameters() {
-		return $this->messageParameters;
-	}
-
-	/**
-	 * @param string $message
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message is invalid
-	 * @since 8.2.0
-	 */
-	public function setParsedMessage($message) {
-		if (!is_string($message) || $message === '') {
-			throw new \InvalidArgumentException('The given parsed message is invalid');
-		}
-		$this->messageParsed = $message;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getParsedMessage() {
-		return $this->messageParsed;
-	}
-
-	/**
-	 * @param string $message
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 11.0.0
-	 */
-	public function setRichMessage($message, array $parameters = []) {
-		if (!is_string($message) || $message === '') {
-			throw new \InvalidArgumentException('The given parsed message is invalid');
-		}
-
-		$this->messageRich = $message;
-		$this->messageRichParameters = $parameters;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichMessage() {
-		return $this->messageRich;
-	}
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichMessageParameters() {
-		return $this->messageRichParameters;
-	}
-
-	/**
-	 * @param string $link
-	 * @return $this
-	 * @throws \InvalidArgumentException if the link is invalid
-	 * @since 8.2.0
-	 */
-	public function setLink($link) {
-		if (!is_string($link) || $link === '' || isset($link[4000])) {
-			throw new \InvalidArgumentException('The given link is invalid');
-		}
-		$this->link = $link;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getLink() {
-		return $this->link;
-	}
-
-	/**
-	 * @param string $icon
-	 * @return $this
-	 * @throws \InvalidArgumentException if the icon is invalid
-	 * @since 11.0.0
-	 */
-	public function setIcon($icon) {
-		if (!is_string($icon) || $icon === '' || isset($icon[4000])) {
-			throw new \InvalidArgumentException('The given icon is invalid');
-		}
-		$this->icon = $icon;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getIcon() {
-		return $this->icon;
-	}
-
-	/**
-	 * @return IAction
-	 * @since 8.2.0
-	 */
-	public function createAction() {
-		return new Action();
-	}
-
-	/**
-	 * @param IAction $action
-	 * @return $this
-	 * @throws \InvalidArgumentException if the action is invalid
-	 * @since 8.2.0
-	 */
-	public function addAction(IAction $action) {
-		if (!$action->isValid()) {
-			throw new \InvalidArgumentException('The given action is invalid');
-		}
-
-		if ($action->isPrimary()) {
-			if ($this->hasPrimaryAction) {
-				throw new \InvalidArgumentException('The notification already has a primary action');
-			}
-
-			$this->hasPrimaryAction = true;
-		}
-
-		$this->actions[] = $action;
-		return $this;
-	}
-
-	/**
-	 * @return IAction[]
-	 * @since 8.2.0
-	 */
-	public function getActions() {
-		return $this->actions;
-	}
-
-	/**
-	 * @param IAction $action
-	 * @return $this
-	 * @throws \InvalidArgumentException if the action is invalid
-	 * @since 8.2.0
-	 */
-	public function addParsedAction(IAction $action) {
-		if (!$action->isValidParsed()) {
-			throw new \InvalidArgumentException('The given parsed action is invalid');
-		}
-
-		if ($action->isPrimary()) {
-			if ($this->hasPrimaryParsedAction) {
-				throw new \InvalidArgumentException('The notification already has a primary action');
-			}
-
-			$this->hasPrimaryParsedAction = true;
-
-			// Make sure the primary action is always the first one
-			array_unshift($this->actionsParsed, $action);
-		} else {
-			$this->actionsParsed[] = $action;
-		}
-
-		return $this;
-	}
-
-	/**
-	 * @return IAction[]
-	 * @since 8.2.0
-	 */
-	public function getParsedActions() {
-		return $this->actionsParsed;
-	}
-
-	/**
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function isValid() {
-		return
-			$this->isValidCommon()
-			&&
-			$this->getSubject() !== ''
-		;
-	}
-
-	/**
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function isValidParsed() {
-		if ($this->getRichSubject() !== '' || !empty($this->getRichSubjectParameters())) {
-			try {
-				$this->richValidator->validate($this->getRichSubject(), $this->getRichSubjectParameters());
-			} catch (InvalidObjectExeption $e) {
-				return false;
-			}
-		}
-
-		if ($this->getRichMessage() !== '' || !empty($this->getRichMessageParameters())) {
-			try {
-				$this->richValidator->validate($this->getRichMessage(), $this->getRichMessageParameters());
-			} catch (InvalidObjectExeption $e) {
-				return false;
-			}
-		}
-
-		return
-			$this->isValidCommon()
-			&&
-			$this->getParsedSubject() !== ''
-		;
-	}
-
-	/**
-	 * @return bool
-	 */
-	protected function isValidCommon() {
-		return
-			$this->getApp() !== ''
-			&&
-			$this->getUser() !== ''
-			&&
-			$this->getDateTime()->getTimestamp() !== 0
-			&&
-			$this->getObjectType() !== ''
-			&&
-			$this->getObjectId() !== ''
-		;
-	}
+    /** @var IValidator */
+    protected $richValidator;
+
+    /** @var string */
+    protected $app;
+
+    /** @var string */
+    protected $user;
+
+    /** @var \DateTime */
+    protected $dateTime;
+
+    /** @var string */
+    protected $objectType;
+
+    /** @var string */
+    protected $objectId;
+
+    /** @var string */
+    protected $subject;
+
+    /** @var array */
+    protected $subjectParameters;
+
+    /** @var string */
+    protected $subjectParsed;
+
+    /** @var string */
+    protected $subjectRich;
+
+    /** @var array */
+    protected $subjectRichParameters;
+
+    /** @var string */
+    protected $message;
+
+    /** @var array */
+    protected $messageParameters;
+
+    /** @var string */
+    protected $messageParsed;
+
+    /** @var string */
+    protected $messageRich;
+
+    /** @var array */
+    protected $messageRichParameters;
+
+    /** @var string */
+    protected $link;
+
+    /** @var string */
+    protected $icon;
+
+    /** @var array */
+    protected $actions;
+
+    /** @var array */
+    protected $actionsParsed;
+
+    /** @var bool */
+    protected $hasPrimaryAction;
+
+    /** @var bool */
+    protected $hasPrimaryParsedAction;
+
+    /**
+     * Constructor
+     *
+     * @param IValidator $richValidator
+     */
+    public function __construct(IValidator $richValidator) {
+        $this->richValidator = $richValidator;
+        $this->app = '';
+        $this->user = '';
+        $this->dateTime = new \DateTime();
+        $this->dateTime->setTimestamp(0);
+        $this->objectType = '';
+        $this->objectId = '';
+        $this->subject = '';
+        $this->subjectParameters = [];
+        $this->subjectParsed = '';
+        $this->subjectRich = '';
+        $this->subjectRichParameters = [];
+        $this->message = '';
+        $this->messageParameters = [];
+        $this->messageParsed = '';
+        $this->messageRich = '';
+        $this->messageRichParameters = [];
+        $this->link = '';
+        $this->icon = '';
+        $this->actions = [];
+        $this->actionsParsed = [];
+    }
+
+    /**
+     * @param string $app
+     * @return $this
+     * @throws \InvalidArgumentException if the app id is invalid
+     * @since 8.2.0
+     */
+    public function setApp($app) {
+        if (!is_string($app) || $app === '' || isset($app[32])) {
+            throw new \InvalidArgumentException('The given app name is invalid');
+        }
+        $this->app = $app;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getApp() {
+        return $this->app;
+    }
+
+    /**
+     * @param string $user
+     * @return $this
+     * @throws \InvalidArgumentException if the user id is invalid
+     * @since 8.2.0
+     */
+    public function setUser($user) {
+        if (!is_string($user) || $user === '' || isset($user[64])) {
+            throw new \InvalidArgumentException('The given user id is invalid');
+        }
+        $this->user = $user;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getUser() {
+        return $this->user;
+    }
+
+    /**
+     * @param \DateTime $dateTime
+     * @return $this
+     * @throws \InvalidArgumentException if the $dateTime is invalid
+     * @since 9.0.0
+     */
+    public function setDateTime(\DateTime $dateTime) {
+        if ($dateTime->getTimestamp() === 0) {
+            throw new \InvalidArgumentException('The given date time is invalid');
+        }
+        $this->dateTime = $dateTime;
+        return $this;
+    }
+
+    /**
+     * @return \DateTime
+     * @since 9.0.0
+     */
+    public function getDateTime() {
+        return $this->dateTime;
+    }
+
+    /**
+     * @param string $type
+     * @param string $id
+     * @return $this
+     * @throws \InvalidArgumentException if the object type or id is invalid
+     * @since 8.2.0 - 9.0.0: Type of $id changed to string
+     */
+    public function setObject($type, $id) {
+        if (!is_string($type) || $type === '' || isset($type[64])) {
+            throw new \InvalidArgumentException('The given object type is invalid');
+        }
+        $this->objectType = $type;
+
+        if (!is_int($id) && (!is_string($id) || $id === '' || isset($id[64]))) {
+            throw new \InvalidArgumentException('The given object id is invalid');
+        }
+        $this->objectId = (string) $id;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getObjectType() {
+        return $this->objectType;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0 - 9.0.0: Return type changed to string
+     */
+    public function getObjectId() {
+        return $this->objectId;
+    }
+
+    /**
+     * @param string $subject
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setSubject($subject, array $parameters = []) {
+        if (!is_string($subject) || $subject === '' || isset($subject[64])) {
+            throw new \InvalidArgumentException('The given subject is invalid');
+        }
+
+        $this->subject = $subject;
+        $this->subjectParameters = $parameters;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getSubject() {
+        return $this->subject;
+    }
+
+    /**
+     * @return string[]
+     * @since 8.2.0
+     */
+    public function getSubjectParameters() {
+        return $this->subjectParameters;
+    }
+
+    /**
+     * @param string $subject
+     * @return $this
+     * @throws \InvalidArgumentException if the subject is invalid
+     * @since 8.2.0
+     */
+    public function setParsedSubject($subject) {
+        if (!is_string($subject) || $subject === '') {
+            throw new \InvalidArgumentException('The given parsed subject is invalid');
+        }
+        $this->subjectParsed = $subject;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getParsedSubject() {
+        return $this->subjectParsed;
+    }
+
+    /**
+     * @param string $subject
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 11.0.0
+     */
+    public function setRichSubject($subject, array $parameters = []) {
+        if (!is_string($subject) || $subject === '') {
+            throw new \InvalidArgumentException('The given parsed subject is invalid');
+        }
+
+        $this->subjectRich = $subject;
+        $this->subjectRichParameters = $parameters;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichSubject() {
+        return $this->subjectRich;
+    }
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichSubjectParameters() {
+        return $this->subjectRichParameters;
+    }
+
+    /**
+     * @param string $message
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setMessage($message, array $parameters = []) {
+        if (!is_string($message) || $message === '' || isset($message[64])) {
+            throw new \InvalidArgumentException('The given message is invalid');
+        }
+
+        $this->message = $message;
+        $this->messageParameters = $parameters;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getMessage() {
+        return $this->message;
+    }
+
+    /**
+     * @return string[]
+     * @since 8.2.0
+     */
+    public function getMessageParameters() {
+        return $this->messageParameters;
+    }
+
+    /**
+     * @param string $message
+     * @return $this
+     * @throws \InvalidArgumentException if the message is invalid
+     * @since 8.2.0
+     */
+    public function setParsedMessage($message) {
+        if (!is_string($message) || $message === '') {
+            throw new \InvalidArgumentException('The given parsed message is invalid');
+        }
+        $this->messageParsed = $message;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getParsedMessage() {
+        return $this->messageParsed;
+    }
+
+    /**
+     * @param string $message
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 11.0.0
+     */
+    public function setRichMessage($message, array $parameters = []) {
+        if (!is_string($message) || $message === '') {
+            throw new \InvalidArgumentException('The given parsed message is invalid');
+        }
+
+        $this->messageRich = $message;
+        $this->messageRichParameters = $parameters;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichMessage() {
+        return $this->messageRich;
+    }
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichMessageParameters() {
+        return $this->messageRichParameters;
+    }
+
+    /**
+     * @param string $link
+     * @return $this
+     * @throws \InvalidArgumentException if the link is invalid
+     * @since 8.2.0
+     */
+    public function setLink($link) {
+        if (!is_string($link) || $link === '' || isset($link[4000])) {
+            throw new \InvalidArgumentException('The given link is invalid');
+        }
+        $this->link = $link;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getLink() {
+        return $this->link;
+    }
+
+    /**
+     * @param string $icon
+     * @return $this
+     * @throws \InvalidArgumentException if the icon is invalid
+     * @since 11.0.0
+     */
+    public function setIcon($icon) {
+        if (!is_string($icon) || $icon === '' || isset($icon[4000])) {
+            throw new \InvalidArgumentException('The given icon is invalid');
+        }
+        $this->icon = $icon;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getIcon() {
+        return $this->icon;
+    }
+
+    /**
+     * @return IAction
+     * @since 8.2.0
+     */
+    public function createAction() {
+        return new Action();
+    }
+
+    /**
+     * @param IAction $action
+     * @return $this
+     * @throws \InvalidArgumentException if the action is invalid
+     * @since 8.2.0
+     */
+    public function addAction(IAction $action) {
+        if (!$action->isValid()) {
+            throw new \InvalidArgumentException('The given action is invalid');
+        }
+
+        if ($action->isPrimary()) {
+            if ($this->hasPrimaryAction) {
+                throw new \InvalidArgumentException('The notification already has a primary action');
+            }
+
+            $this->hasPrimaryAction = true;
+        }
+
+        $this->actions[] = $action;
+        return $this;
+    }
+
+    /**
+     * @return IAction[]
+     * @since 8.2.0
+     */
+    public function getActions() {
+        return $this->actions;
+    }
+
+    /**
+     * @param IAction $action
+     * @return $this
+     * @throws \InvalidArgumentException if the action is invalid
+     * @since 8.2.0
+     */
+    public function addParsedAction(IAction $action) {
+        if (!$action->isValidParsed()) {
+            throw new \InvalidArgumentException('The given parsed action is invalid');
+        }
+
+        if ($action->isPrimary()) {
+            if ($this->hasPrimaryParsedAction) {
+                throw new \InvalidArgumentException('The notification already has a primary action');
+            }
+
+            $this->hasPrimaryParsedAction = true;
+
+            // Make sure the primary action is always the first one
+            array_unshift($this->actionsParsed, $action);
+        } else {
+            $this->actionsParsed[] = $action;
+        }
+
+        return $this;
+    }
+
+    /**
+     * @return IAction[]
+     * @since 8.2.0
+     */
+    public function getParsedActions() {
+        return $this->actionsParsed;
+    }
+
+    /**
+     * @return bool
+     * @since 8.2.0
+     */
+    public function isValid() {
+        return
+            $this->isValidCommon()
+            &&
+            $this->getSubject() !== ''
+        ;
+    }
+
+    /**
+     * @return bool
+     * @since 8.2.0
+     */
+    public function isValidParsed() {
+        if ($this->getRichSubject() !== '' || !empty($this->getRichSubjectParameters())) {
+            try {
+                $this->richValidator->validate($this->getRichSubject(), $this->getRichSubjectParameters());
+            } catch (InvalidObjectExeption $e) {
+                return false;
+            }
+        }
+
+        if ($this->getRichMessage() !== '' || !empty($this->getRichMessageParameters())) {
+            try {
+                $this->richValidator->validate($this->getRichMessage(), $this->getRichMessageParameters());
+            } catch (InvalidObjectExeption $e) {
+                return false;
+            }
+        }
+
+        return
+            $this->isValidCommon()
+            &&
+            $this->getParsedSubject() !== ''
+        ;
+    }
+
+    /**
+     * @return bool
+     */
+    protected function isValidCommon() {
+        return
+            $this->getApp() !== ''
+            &&
+            $this->getUser() !== ''
+            &&
+            $this->getDateTime()->getTimestamp() !== 0
+            &&
+            $this->getObjectType() !== ''
+            &&
+            $this->getObjectId() !== ''
+        ;
+    }
 }

lib/private/Notification/Action.php

Indentation +144 added lines, -144 removed lines

@@ -27,148 +27,148 @@
 
 class Action implements IAction {
 
-	/** @var string */
-	protected $label;
-
-	/** @var string */
-	protected $labelParsed;
-
-	/** @var string */
-	protected $link;
-
-	/** @var string */
-	protected $requestType;
-
-	/** @var string */
-	protected $icon;
-
-	/** @var bool */
-	protected $primary;
-
-	/**
-	 * Constructor
-	 */
-	public function __construct() {
-		$this->label = '';
-		$this->labelParsed = '';
-		$this->link = '';
-		$this->requestType = '';
-		$this->primary = false;
-	}
-
-	/**
-	 * @param string $label
-	 * @return $this
-	 * @throws \InvalidArgumentException if the label is invalid
-	 * @since 8.2.0
-	 */
-	public function setLabel($label) {
-		if (!is_string($label) || $label === '' || isset($label[32])) {
-			throw new \InvalidArgumentException('The given label is invalid');
-		}
-		$this->label = $label;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getLabel() {
-		return $this->label;
-	}
-
-	/**
-	 * @param string $label
-	 * @return $this
-	 * @throws \InvalidArgumentException if the label is invalid
-	 * @since 8.2.0
-	 */
-	public function setParsedLabel($label) {
-		if (!is_string($label) || $label === '') {
-			throw new \InvalidArgumentException('The given parsed label is invalid');
-		}
-		$this->labelParsed = $label;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getParsedLabel() {
-		return $this->labelParsed;
-	}
-
-	/**
-	 * @param $primary bool
-	 * @return $this
-	 * @throws \InvalidArgumentException if $primary is invalid
-	 * @since 9.0.0
-	 */
-	public function setPrimary($primary) {
-		if (!is_bool($primary)) {
-			throw new \InvalidArgumentException('The given primary option is invalid');
-		}
-
-		$this->primary = $primary;
-		return $this;
-	}
-
-	/**
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function isPrimary() {
-		return $this->primary;
-	}
-
-	/**
-	 * @param string $link
-	 * @param string $requestType
-	 * @return $this
-	 * @throws \InvalidArgumentException if the link is invalid
-	 * @since 8.2.0
-	 */
-	public function setLink($link, $requestType) {
-		if (!is_string($link) || $link === '' || isset($link[256])) {
-			throw new \InvalidArgumentException('The given link is invalid');
-		}
-		if (!in_array($requestType, ['GET', 'POST', 'PUT', 'DELETE'], true)) {
-			throw new \InvalidArgumentException('The given request type is invalid');
-		}
-		$this->link = $link;
-		$this->requestType = $requestType;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getLink() {
-		return $this->link;
-	}
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getRequestType() {
-		return $this->requestType;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isValid() {
-		return $this->label !== '' && $this->link !== '';
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isValidParsed() {
-		return $this->labelParsed !== '' && $this->link !== '';
-	}
+    /** @var string */
+    protected $label;
+
+    /** @var string */
+    protected $labelParsed;
+
+    /** @var string */
+    protected $link;
+
+    /** @var string */
+    protected $requestType;
+
+    /** @var string */
+    protected $icon;
+
+    /** @var bool */
+    protected $primary;
+
+    /**
+     * Constructor
+     */
+    public function __construct() {
+        $this->label = '';
+        $this->labelParsed = '';
+        $this->link = '';
+        $this->requestType = '';
+        $this->primary = false;
+    }
+
+    /**
+     * @param string $label
+     * @return $this
+     * @throws \InvalidArgumentException if the label is invalid
+     * @since 8.2.0
+     */
+    public function setLabel($label) {
+        if (!is_string($label) || $label === '' || isset($label[32])) {
+            throw new \InvalidArgumentException('The given label is invalid');
+        }
+        $this->label = $label;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getLabel() {
+        return $this->label;
+    }
+
+    /**
+     * @param string $label
+     * @return $this
+     * @throws \InvalidArgumentException if the label is invalid
+     * @since 8.2.0
+     */
+    public function setParsedLabel($label) {
+        if (!is_string($label) || $label === '') {
+            throw new \InvalidArgumentException('The given parsed label is invalid');
+        }
+        $this->labelParsed = $label;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getParsedLabel() {
+        return $this->labelParsed;
+    }
+
+    /**
+     * @param $primary bool
+     * @return $this
+     * @throws \InvalidArgumentException if $primary is invalid
+     * @since 9.0.0
+     */
+    public function setPrimary($primary) {
+        if (!is_bool($primary)) {
+            throw new \InvalidArgumentException('The given primary option is invalid');
+        }
+
+        $this->primary = $primary;
+        return $this;
+    }
+
+    /**
+     * @return bool
+     * @since 9.0.0
+     */
+    public function isPrimary() {
+        return $this->primary;
+    }
+
+    /**
+     * @param string $link
+     * @param string $requestType
+     * @return $this
+     * @throws \InvalidArgumentException if the link is invalid
+     * @since 8.2.0
+     */
+    public function setLink($link, $requestType) {
+        if (!is_string($link) || $link === '' || isset($link[256])) {
+            throw new \InvalidArgumentException('The given link is invalid');
+        }
+        if (!in_array($requestType, ['GET', 'POST', 'PUT', 'DELETE'], true)) {
+            throw new \InvalidArgumentException('The given request type is invalid');
+        }
+        $this->link = $link;
+        $this->requestType = $requestType;
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getLink() {
+        return $this->link;
+    }
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getRequestType() {
+        return $this->requestType;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isValid() {
+        return $this->label !== '' && $this->link !== '';
+    }
+
+    /**
+     * @return bool
+     */
+    public function isValidParsed() {
+        return $this->labelParsed !== '' && $this->link !== '';
+    }
 }