eventespresso / event-espresso-core

core/services/request/RequestDecoratorInterface.php

Indentation +17 added lines, -17 removed lines

@@ -12,21 +12,21 @@
 interface RequestDecoratorInterface
 {
 
-    /**
-     * converts a Request to a Response
-     * can perform their logic either before or after the core application has run like so:
-     *    public function handle_request( EE_Request $request, EE_Response $response ) {
-     *        $this->request = $request;
-     *        $this->response = $response;
-     *      // logic performed BEFORE core app has run
-     *      $this->process_request_stack( $this->request, $this->response );
-     *      // logic performed AFTER core app has run
-     *      return $response;
-     *    }
-     *
-     * @param RequestInterface $request
-     * @param ResponseInterface      $response
-     * @return ResponseInterface
-     */
-    public function handleRequest(RequestInterface $request, ResponseInterface $response);
+	/**
+	 * converts a Request to a Response
+	 * can perform their logic either before or after the core application has run like so:
+	 *    public function handle_request( EE_Request $request, EE_Response $response ) {
+	 *        $this->request = $request;
+	 *        $this->response = $response;
+	 *      // logic performed BEFORE core app has run
+	 *      $this->process_request_stack( $this->request, $this->response );
+	 *      // logic performed AFTER core app has run
+	 *      return $response;
+	 *    }
+	 *
+	 * @param RequestInterface $request
+	 * @param ResponseInterface      $response
+	 * @return ResponseInterface
+	 */
+	public function handleRequest(RequestInterface $request, ResponseInterface $response);
 }

core/services/request/ResponseInterface.php

Indentation +55 added lines, -55 removed lines

@@ -12,67 +12,67 @@
 interface ResponseInterface
 {
 
-    /**
-     *    set_notice
-     *
-     * @access    public
-     * @param $key
-     * @param $value
-     * @return    void
-     */
-    public function setNotice($key, $value);
+	/**
+	 *    set_notice
+	 *
+	 * @access    public
+	 * @param $key
+	 * @param $value
+	 * @return    void
+	 */
+	public function setNotice($key, $value);
 
-    /**
-     *    get_notice
-     *
-     * @access    public
-     * @param $key
-     * @return    mixed
-     */
-    public function getNotice($key);
+	/**
+	 *    get_notice
+	 *
+	 * @access    public
+	 * @param $key
+	 * @return    mixed
+	 */
+	public function getNotice($key);
 
-    /**
-     *    get_notices
-     *
-     * @access    public
-     * @return    array
-     */
-    public function getNotices();
+	/**
+	 *    get_notices
+	 *
+	 * @access    public
+	 * @return    array
+	 */
+	public function getNotices();
 
-    /**
-     *    add_output
-     *
-     * @access    public
-     * @param      $string
-     * @param bool $append
-     */
-    public function addOutput($string, $append = true);
+	/**
+	 *    add_output
+	 *
+	 * @access    public
+	 * @param      $string
+	 * @param bool $append
+	 */
+	public function addOutput($string, $append = true);
 
-    /**
-     *    get_output
-     *
-     * @access    public
-     * @return    string
-     */
-    public function getOutput();
+	/**
+	 *    get_output
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function getOutput();
 
-    /**
-     * @return boolean
-     */
-    public function requestTerminated();
+	/**
+	 * @return boolean
+	 */
+	public function requestTerminated();
 
-    /**
-     * @param boolean $request_terminated
-     */
-    public function terminateRequest($request_terminated = true);
+	/**
+	 * @param boolean $request_terminated
+	 */
+	public function terminateRequest($request_terminated = true);
 
-    /**
-     * @return boolean
-     */
-    public function pluginDeactivated();
+	/**
+	 * @return boolean
+	 */
+	public function pluginDeactivated();
 
-    /**
-     * sets $deactivate_plugin to true
-     */
-    public function deactivatePlugin();
+	/**
+	 * sets $deactivate_plugin to true
+	 */
+	public function deactivatePlugin();
 }

core/services/commands/CommandRequiresCapCheckInterface.php

Indentation +4 added lines, -4 removed lines

@@ -11,8 +11,8 @@
 interface CommandRequiresCapCheckInterface
 {
 
-    /**
-     * @return \EventEspresso\core\domain\services\capabilities\CapCheck
-     */
-    public function getCapCheck();
+	/**
+	 * @return \EventEspresso\core\domain\services\capabilities\CapCheck
+	 */
+	public function getCapCheck();
 }

core/services/commands/CommandFactoryInterface.php

Indentation +9 added lines, -9 removed lines

@@ -9,13 +9,13 @@
 interface CommandFactoryInterface
 {
 
-    /**
-     * @param string $command_fqcn
-     * @param array  $arguments
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function getNew($command_fqcn, $arguments = array());
+	/**
+	 * @param string $command_fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function getNew($command_fqcn, $arguments = array());
 }

core/services/commands/CommandBusInterface.php

Indentation +9 added lines, -9 removed lines

@@ -9,14 +9,14 @@
 interface CommandBusInterface
 {
 
-    /**
-     * @return CommandHandlerManagerInterface
-     */
-    public function getCommandHandlerManager();
+	/**
+	 * @return CommandHandlerManagerInterface
+	 */
+	public function getCommandHandlerManager();
 
-    /**
-     * @param \EventEspresso\core\services\commands\CommandInterface $command
-     * @return mixed
-     */
-    public function execute($command);
+	/**
+	 * @param \EventEspresso\core\services\commands\CommandInterface $command
+	 * @return mixed
+	 */
+	public function execute($command);
 }

core/services/commands/middleware/CommandBusMiddlewareInterface.php

Indentation +6 added lines, -6 removed lines

@@ -12,10 +12,10 @@
 interface CommandBusMiddlewareInterface
 {
 
-    /**
-     * @param CommandInterface $command
-     * @param Closure         $next
-     * @return mixed
-     */
-    public function handle(CommandInterface $command, Closure $next);
+	/**
+	 * @param CommandInterface $command
+	 * @param Closure         $next
+	 * @return mixed
+	 */
+	public function handle(CommandInterface $command, Closure $next);
 }

core/services/cache/CacheManagerInterface.php

Indentation +37 added lines, -37 removed lines

@@ -14,41 +14,41 @@
 interface CacheManagerInterface
 {
 
-    /**
-     * returns a string that will be prepended to all cache identifiers
-     *
-     * @return string
-     */
-    public function cachePrefix();
-
-
-
-    /**
-     * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
-     *                           May also be helpful to include an additional specific identifier,
-     *                           such as a post ID as part of the $id_prefix so that individual caches
-     *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
-     *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
-     * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
-     *                           It is advisable to use some of the actual data
-     *                           that is used to generate the content being cached,
-     *                           in order to guarantee that the cache id is unique for that content.
-     *                           The cache id will be md5'd before usage to make it more db friendly,
-     *                           and the entire cache id string will be truncated to 190 characters.
-     * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
-     *                           necessary,
-     *                           we wrap our content creation in a Closure so that it is not executed until needed.
-     * @param int     $expiration
-     * @return Closure|mixed
-     */
-    public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS);
-
-
-
-    /**
-     * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
-     *                               or a specific ID targeting a single cache item
-     * @return void
-     */
-    public function clear($cache_id);
+	/**
+	 * returns a string that will be prepended to all cache identifiers
+	 *
+	 * @return string
+	 */
+	public function cachePrefix();
+
+
+
+	/**
+	 * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
+	 *                           May also be helpful to include an additional specific identifier,
+	 *                           such as a post ID as part of the $id_prefix so that individual caches
+	 *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
+	 *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
+	 * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
+	 *                           It is advisable to use some of the actual data
+	 *                           that is used to generate the content being cached,
+	 *                           in order to guarantee that the cache id is unique for that content.
+	 *                           The cache id will be md5'd before usage to make it more db friendly,
+	 *                           and the entire cache id string will be truncated to 190 characters.
+	 * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
+	 *                           necessary,
+	 *                           we wrap our content creation in a Closure so that it is not executed until needed.
+	 * @param int     $expiration
+	 * @return Closure|mixed
+	 */
+	public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS);
+
+
+
+	/**
+	 * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
+	 *                               or a specific ID targeting a single cache item
+	 * @return void
+	 */
+	public function clear($cache_id);
 }

core/services/cache/CacheStorageInterface.php

Indentation +46 added lines, -46 removed lines

@@ -11,50 +11,50 @@
 interface CacheStorageInterface
 {
 
-    /**
-     * Saves supplied data
-     * if an expiration is set, then it automatically schedules the cache for deletion
-     *
-     * @param string $key        [required]
-     * @param string $data       [required]
-     * @param int    $expiration number of seconds until the cache expires
-     * @return bool
-     */
-    public function add($key, $data, $expiration = 0);
-
-
-
-    /**
-     * retrieves cache data
-     * should automatically trigger early cache refresh for standard cache items
-     * in order to avoid cache stampedes on busy sites.
-     * For non-standard cache items like PHP Session data where early refreshing is not wanted,
-     * the $standard_cache parameter should be set to false when retrieving data
-     *
-     * @param string $key [required]
-     * @param bool   $standard_cache
-     * @return mixed
-     */
-    public function get($key, $standard_cache = true);
-
-
-
-    /**
-     * delete a single cached item
-     *
-     * @param string $key [required] full or partial cache key to be deleted
-     */
-    public function delete($key);
-
-
-
-    /**
-     * delete multiple cached items
-     *
-     * @param array $keys           [required] array of full or partial cache keys to be deleted
-     * @param bool  $force_delete   [optional] if true, then will not check incoming keys against those being tracked
-     *                              and proceed directly to deleting those entries from the cache storage
-     * @return
-     */
-    public function deleteMany(array $keys, $force_delete = false);
+	/**
+	 * Saves supplied data
+	 * if an expiration is set, then it automatically schedules the cache for deletion
+	 *
+	 * @param string $key        [required]
+	 * @param string $data       [required]
+	 * @param int    $expiration number of seconds until the cache expires
+	 * @return bool
+	 */
+	public function add($key, $data, $expiration = 0);
+
+
+
+	/**
+	 * retrieves cache data
+	 * should automatically trigger early cache refresh for standard cache items
+	 * in order to avoid cache stampedes on busy sites.
+	 * For non-standard cache items like PHP Session data where early refreshing is not wanted,
+	 * the $standard_cache parameter should be set to false when retrieving data
+	 *
+	 * @param string $key [required]
+	 * @param bool   $standard_cache
+	 * @return mixed
+	 */
+	public function get($key, $standard_cache = true);
+
+
+
+	/**
+	 * delete a single cached item
+	 *
+	 * @param string $key [required] full or partial cache key to be deleted
+	 */
+	public function delete($key);
+
+
+
+	/**
+	 * delete multiple cached items
+	 *
+	 * @param array $keys           [required] array of full or partial cache keys to be deleted
+	 * @param bool  $force_delete   [optional] if true, then will not check incoming keys against those being tracked
+	 *                              and proceed directly to deleting those entries from the cache storage
+	 * @return
+	 */
+	public function deleteMany(array $keys, $force_delete = false);
 }

core/services/formatters/FormatterInterface.php

Indentation +14 added lines, -14 removed lines

@@ -12,21 +12,21 @@
 interface FormatterInterface
 {
 
-    /**
-     * Applies the formatting to all items in the array
-     *
-     * @param array $input accepts a multi-dimensional array, but all "leaf nodes" are easily cast to a string
-     * @return array
-     */
-    public function formatArray($input);
+	/**
+	 * Applies the formatting to all items in the array
+	 *
+	 * @param array $input accepts a multi-dimensional array, but all "leaf nodes" are easily cast to a string
+	 * @return array
+	 */
+	public function formatArray($input);
 
 
 
-    /**
-     * Formats the string
-     *
-     * @param string|int|float $input anything easily cast into a string
-     * @return string
-     */
-    public function format($input);
+	/**
+	 * Formats the string
+	 *
+	 * @param string|int|float $input anything easily cast into a string
+	 * @return string
+	 */
+	public function format($input);
 }