eventespresso / event-espresso-core

core/interfaces/EEI_Base.interface.php

Indentation +93 added lines, -93 removed lines

@@ -6,97 +6,97 @@
 interface EEI_Base
 {
 
-    /**
-     * gets the unique ID of the model object. If it hasn't been saved yet
-     * to the database, this should be 0 or NULL
-     */
-    public function ID();
-
-
-
-    /**
-     * Returns an array where keys are field names and values are their values
-     *
-     * @return array
-     */
-    public function model_field_array();
-
-
-
-    /**
-     * Saves the thing to the database and returns success (or an ID)
-     *
-     * @return boolean success on insert; or int on update (ID of newly inserted thing)
-     */
-    public function save();
-
-
-
-    /**
-     * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
-     * A $previous_value can be specified in case there are many meta rows with the same key
-     *
-     * @param string $meta_key
-     * @param string $meta_value
-     * @param string $previous_value
-     * @return int records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
-     * NOTE: if the values haven't changed, returns 0
-     */
-    public function update_extra_meta($meta_key, $meta_value, $previous_value = null);
-
-
-
-    /**
-     * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
-     * no other extra meta for this model object have the same key. Returns TRUE if the
-     * extra meta row was entered, false if not
-     *
-     * @param string  $meta_key
-     * @param string  $meta_value
-     * @param boolean $unique
-     * @return boolean
-     */
-    public function add_extra_meta($meta_key, $meta_value, $unique = false);
-
-
-
-    /**
-     * Deletes all the extra meta rows for this record as specified by key. If $meta_value
-     * is specified, only deletes extra meta records with that value.
-     *
-     * @param string $meta_key
-     * @param string $meta_value
-     * @return int number of extra meta rows deleted
-     */
-    public function delete_extra_meta($meta_key, $meta_value = null);
-
-
-
-    /**
-     * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
-     * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
-     * You can specify $default is case you haven't found the extra meta
-     *
-     * @param string  $meta_key
-     * @param boolean $single
-     * @param mixed   $default if we don't find anything, what should we return?
-     * @return mixed single value if $single; array if ! $single
-     */
-    public function get_extra_meta($meta_key, $single = false, $default = null);
-
-
-
-    /**
-     * Gets a pretty view of the field's value. $extra_cache_ref can specify different formats for this.
-     * The $extra_cache_ref will be passed to the model field's prepare_for_pretty_echoing, so consult the field's class
-     * to see what options are available.
-     *
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function get_pretty($field_name, $extra_cache_ref);
+	/**
+	 * gets the unique ID of the model object. If it hasn't been saved yet
+	 * to the database, this should be 0 or NULL
+	 */
+	public function ID();
+
+
+
+	/**
+	 * Returns an array where keys are field names and values are their values
+	 *
+	 * @return array
+	 */
+	public function model_field_array();
+
+
+
+	/**
+	 * Saves the thing to the database and returns success (or an ID)
+	 *
+	 * @return boolean success on insert; or int on update (ID of newly inserted thing)
+	 */
+	public function save();
+
+
+
+	/**
+	 * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
+	 * A $previous_value can be specified in case there are many meta rows with the same key
+	 *
+	 * @param string $meta_key
+	 * @param string $meta_value
+	 * @param string $previous_value
+	 * @return int records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
+	 * NOTE: if the values haven't changed, returns 0
+	 */
+	public function update_extra_meta($meta_key, $meta_value, $previous_value = null);
+
+
+
+	/**
+	 * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
+	 * no other extra meta for this model object have the same key. Returns TRUE if the
+	 * extra meta row was entered, false if not
+	 *
+	 * @param string  $meta_key
+	 * @param string  $meta_value
+	 * @param boolean $unique
+	 * @return boolean
+	 */
+	public function add_extra_meta($meta_key, $meta_value, $unique = false);
+
+
+
+	/**
+	 * Deletes all the extra meta rows for this record as specified by key. If $meta_value
+	 * is specified, only deletes extra meta records with that value.
+	 *
+	 * @param string $meta_key
+	 * @param string $meta_value
+	 * @return int number of extra meta rows deleted
+	 */
+	public function delete_extra_meta($meta_key, $meta_value = null);
+
+
+
+	/**
+	 * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
+	 * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
+	 * You can specify $default is case you haven't found the extra meta
+	 *
+	 * @param string  $meta_key
+	 * @param boolean $single
+	 * @param mixed   $default if we don't find anything, what should we return?
+	 * @return mixed single value if $single; array if ! $single
+	 */
+	public function get_extra_meta($meta_key, $single = false, $default = null);
+
+
+
+	/**
+	 * Gets a pretty view of the field's value. $extra_cache_ref can specify different formats for this.
+	 * The $extra_cache_ref will be passed to the model field's prepare_for_pretty_echoing, so consult the field's class
+	 * to see what options are available.
+	 *
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($field_name, $extra_cache_ref);
 }

core/services/progress_steps/ProgressStepsConfigInterface.php

Indentation +2 added lines, -2 removed lines

@@ -10,7 +10,7 @@
 interface ProgressStepsConfigInterface
 {
 
-    public function get();
+	public function get();
 
-    public function update();
+	public function update();
 }

core/services/progress_steps/display_strategies/ProgressStepsDisplayInterface.php

Indentation +18 added lines, -18 removed lines

@@ -11,23 +11,23 @@
 interface ProgressStepsDisplayInterface
 {
 
-    /**
-     * used for setting up css and js required for the display strategy
-     * ** IMPORTANT **
-     * This needs to be called BEFORE the wp_enqueue_scripts hook point for the frontend
-     * or the admin_enqueue_scripts in the admin.
-     * If setting up steps for the admin, this can be done via the
-     * 'FHEE__EE_Admin_Page___load_page_dependencies__after_load' ACTION
-     * in \EE_Admin_Page::_load_page_dependencies() or the targeted hook that comes after it
-     *
-     * @return void
-     */
-    public function enqueueStylesAndScripts();
+	/**
+	 * used for setting up css and js required for the display strategy
+	 * ** IMPORTANT **
+	 * This needs to be called BEFORE the wp_enqueue_scripts hook point for the frontend
+	 * or the admin_enqueue_scripts in the admin.
+	 * If setting up steps for the admin, this can be done via the
+	 * 'FHEE__EE_Admin_Page___load_page_dependencies__after_load' ACTION
+	 * in \EE_Admin_Page::_load_page_dependencies() or the targeted hook that comes after it
+	 *
+	 * @return void
+	 */
+	public function enqueueStylesAndScripts();
 
-    /**
-     * loads and returns a full server path to the template used for the display strategy
-     *
-     * @return string
-     */
-    public function getTemplate();
+	/**
+	 * loads and returns a full server path to the template used for the display strategy
+	 *
+	 * @return string
+	 */
+	public function getTemplate();
 }

core/services/collections/iterators/FilterIteratorsHelper.php

Indentation +14 added lines, -14 removed lines

@@ -17,18 +17,18 @@
 {
 
 
-    /**
-     * Uses CollectionFilterCallbackIterator on a provided collection with provided Closure for filtering each object
-     * in the collection.
-     * The closure receives an instance of the object and should return false if it is not "valid" and true if it is.
-     *
-     * @param Collection $collection
-     * @param Closure    $acceptance_callback
-     * @return array
-     */
-    public static function getFilteredObjectsFromCollection(Collection $collection, Closure $acceptance_callback)
-    {
-        $collection_filter_iterator = new CollectionFilterCallbackIterator($collection, $acceptance_callback);
-        return $collection_filter_iterator->getFiltered();
-    }
+	/**
+	 * Uses CollectionFilterCallbackIterator on a provided collection with provided Closure for filtering each object
+	 * in the collection.
+	 * The closure receives an instance of the object and should return false if it is not "valid" and true if it is.
+	 *
+	 * @param Collection $collection
+	 * @param Closure    $acceptance_callback
+	 * @return array
+	 */
+	public static function getFilteredObjectsFromCollection(Collection $collection, Closure $acceptance_callback)
+	{
+		$collection_filter_iterator = new CollectionFilterCallbackIterator($collection, $acceptance_callback);
+		return $collection_filter_iterator->getFiltered();
+	}
 }

core/services/collections/CollectionDetailsInterface.php

Indentation +41 added lines, -41 removed lines

@@ -11,45 +11,45 @@
 interface CollectionDetailsInterface
 {
 
-    /**
-     * @access public
-     * @return string
-     */
-    public function getCollectionInterface();
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function collectionName();
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function identifierType();
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function identifierCallback();
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function getFileMask();
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getCollectionFQCNs();
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getCollectionPaths();
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function getCollectionInterface();
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function collectionName();
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function identifierType();
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function identifierCallback();
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function getFileMask();
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getCollectionFQCNs();
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getCollectionPaths();
 }

core/services/request/RequestStackCoreAppInterface.php

Indentation +7 added lines, -7 removed lines

@@ -12,11 +12,11 @@
 interface RequestStackCoreAppInterface
 {
 
-    /**
-     * gives the core app a chance to handle the response after the request stack has fully processed
-     *
-     * @param RequestInterface $request
-     * @param ResponseInterface      $response
-     */
-    public function handleResponse(RequestInterface $request, ResponseInterface $response);
+	/**
+	 * gives the core app a chance to handle the response after the request stack has fully processed
+	 *
+	 * @param RequestInterface $request
+	 * @param ResponseInterface      $response
+	 */
+	public function handleResponse(RequestInterface $request, ResponseInterface $response);
 }

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/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());
 }