eventespresso / event-espresso-core

core/services/request/files/FileSubmission.php

Indentation +158 added lines, -158 removed lines

@@ -19,164 +19,164 @@
  */
 class FileSubmission implements FileSubmissionInterface
 {
-    /**
-     * @var string original name on the client machine
-     */
-    protected $name;
-
-    /**
-     * @var string mime type
-     */
-    protected $type;
-
-    /**
-     * @var string file extension
-     */
-    protected $extension;
-
-    /**
-     * @var int in bytes
-     */
-    protected $size;
-
-    /**
-     * @var string local filepath to the temporary file
-     */
-    protected $tmp_file;
-
-    /**
-     * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values
-     * although those aren't expected.
-     */
-    protected $error_code;
-
-    /**
-     * FileSubmission constructor.
-     * @param $name
-     * @param $tmp_file
-     * @param $size
-     * @param null $error_code
-     * @throws InvalidArgumentException
-     */
-    public function __construct($name, $tmp_file, $size, $error_code = null)
-    {
-        $this->name = basename($name);
-        $scheme = parse_url($tmp_file, PHP_URL_SCHEME);
-        if (in_array($scheme, ['http', 'https'])) {
-            // Wait a minute- just local filepaths please, no URL schemes allowed!
-            throw new InvalidArgumentException(
-                sprintf(
-                    // @codingStandardsIgnoreStart
-                    esc_html__('The scheme ("%1$s") on the temporary file ("%2$s") indicates is located elsewhere, that’s not ok!', 'event_espresso'),
-                    // @codingStandardsIgnoreEnd
-                    $scheme,
-                    $tmp_file
-                )
-            );
-        }
-        $this->tmp_file = (string) $tmp_file;
-        $this->size = (int) $size;
-        $this->error_code = (int) $error_code;
-    }
-
-    /**
-     * @return string
-     */
-    public function getName()
-    {
-        return $this->name;
-    }
-
-    /**
-     * Gets the file's mime type
-     * @return string
-     */
-    public function getType()
-    {
-        if (!$this->type) {
-            $this->type = $this->determineType();
-        }
-        return $this->type;
-    }
-
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    protected function determineType()
-    {
-        if (!$this->getTmpFile()) {
-            return '';
-        }
-        $finfo = new finfo(FILEINFO_MIME_TYPE);
-        return $finfo->file($this->getTmpFile());
-    }
-
-    /**
-     * Gets the file's extension.
-     * @since $VID:$
-     * @return string
-     */
-    public function getExtension()
-    {
-        if (!$this->extension) {
-            $this->extension = $this->determineExtension();
-        }
-        return $this->extension;
-    }
-
-    /**
-     * Determine's the file's extension given the temporary file.
-     * @since $VID:$
-     * @return string
-     */
-    protected function determineExtension()
-    {
-        $position_of_period = strrpos($this->getName(), '.');
-        if ($position_of_period === false) {
-            return '';
-        }
-        return mb_substr(
-            $this->getName(),
-            $position_of_period + 1
-        );
-    }
-
-    /**
-     * Gets the size of the file
-     * @return int
-     */
-    public function getSize()
-    {
-        return $this->size;
-    }
-
-    /**
-     * Gets the path to the temporary file which was uploaded.
-     * @return string
-     */
-    public function getTmpFile()
-    {
-        return $this->tmp_file;
-    }
-
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->getName();
-    }
-
-    /**
-     * Gets the error code PHP reported for the file upload.
-     * @return string
-     */
-    public function getErrorCode()
-    {
-        return $this->error_code;
-    }
+	/**
+	 * @var string original name on the client machine
+	 */
+	protected $name;
+
+	/**
+	 * @var string mime type
+	 */
+	protected $type;
+
+	/**
+	 * @var string file extension
+	 */
+	protected $extension;
+
+	/**
+	 * @var int in bytes
+	 */
+	protected $size;
+
+	/**
+	 * @var string local filepath to the temporary file
+	 */
+	protected $tmp_file;
+
+	/**
+	 * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values
+	 * although those aren't expected.
+	 */
+	protected $error_code;
+
+	/**
+	 * FileSubmission constructor.
+	 * @param $name
+	 * @param $tmp_file
+	 * @param $size
+	 * @param null $error_code
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($name, $tmp_file, $size, $error_code = null)
+	{
+		$this->name = basename($name);
+		$scheme = parse_url($tmp_file, PHP_URL_SCHEME);
+		if (in_array($scheme, ['http', 'https'])) {
+			// Wait a minute- just local filepaths please, no URL schemes allowed!
+			throw new InvalidArgumentException(
+				sprintf(
+					// @codingStandardsIgnoreStart
+					esc_html__('The scheme ("%1$s") on the temporary file ("%2$s") indicates is located elsewhere, that’s not ok!', 'event_espresso'),
+					// @codingStandardsIgnoreEnd
+					$scheme,
+					$tmp_file
+				)
+			);
+		}
+		$this->tmp_file = (string) $tmp_file;
+		$this->size = (int) $size;
+		$this->error_code = (int) $error_code;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->name;
+	}
+
+	/**
+	 * Gets the file's mime type
+	 * @return string
+	 */
+	public function getType()
+	{
+		if (!$this->type) {
+			$this->type = $this->determineType();
+		}
+		return $this->type;
+	}
+
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	protected function determineType()
+	{
+		if (!$this->getTmpFile()) {
+			return '';
+		}
+		$finfo = new finfo(FILEINFO_MIME_TYPE);
+		return $finfo->file($this->getTmpFile());
+	}
+
+	/**
+	 * Gets the file's extension.
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function getExtension()
+	{
+		if (!$this->extension) {
+			$this->extension = $this->determineExtension();
+		}
+		return $this->extension;
+	}
+
+	/**
+	 * Determine's the file's extension given the temporary file.
+	 * @since $VID:$
+	 * @return string
+	 */
+	protected function determineExtension()
+	{
+		$position_of_period = strrpos($this->getName(), '.');
+		if ($position_of_period === false) {
+			return '';
+		}
+		return mb_substr(
+			$this->getName(),
+			$position_of_period + 1
+		);
+	}
+
+	/**
+	 * Gets the size of the file
+	 * @return int
+	 */
+	public function getSize()
+	{
+		return $this->size;
+	}
+
+	/**
+	 * Gets the path to the temporary file which was uploaded.
+	 * @return string
+	 */
+	public function getTmpFile()
+	{
+		return $this->tmp_file;
+	}
+
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->getName();
+	}
+
+	/**
+	 * Gets the error code PHP reported for the file upload.
+	 * @return string
+	 */
+	public function getErrorCode()
+	{
+		return $this->error_code;
+	}
 }
 // End of file FileSubmission.php
 // Location: EventEspresso\core\services\request\files/FileSubmission.php

Spacing +3 added lines, -3 removed lines

@@ -93,7 +93,7 @@ 
      */
     public function getType()
     {
-        if (!$this->type) {
+        if ( ! $this->type) {
             $this->type = $this->determineType();
         }
         return $this->type;
@@ -105,7 +105,7 @@ 
      */
     protected function determineType()
     {
-        if (!$this->getTmpFile()) {
+        if ( ! $this->getTmpFile()) {
             return '';
         }
         $finfo = new finfo(FILEINFO_MIME_TYPE);
@@ -119,7 +119,7 @@ 
      */
     public function getExtension()
     {
-        if (!$this->extension) {
+        if ( ! $this->extension) {
             $this->extension = $this->determineExtension();
         }
         return $this->extension;

core/services/locators/FqcnLocator.php

Indentation +154 added lines, -154 removed lines

@@ -17,158 +17,158 @@
 class FqcnLocator extends Locator
 {
 
-    /**
-     * @var array $FQCNs
-     */
-    protected $FQCNs = array();
-
-    /**
-     * @var array $namespaces
-     */
-    protected $namespaces = array();
-
-
-    /**
-     * @access protected
-     * @param string $namespace
-     * @param string $namespace_base_dir
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setNamespace($namespace, $namespace_base_dir)
-    {
-        if (! is_string($namespace)) {
-            throw new InvalidDataTypeException('$namespace', $namespace, 'string');
-        }
-        if (! is_string($namespace_base_dir)) {
-            throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
-        }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getFQCNs()
-    {
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * @access public
-     * @return int
-     */
-    public function count()
-    {
-        return count($this->FQCNs);
-    }
-
-
-    /**
-     * given a valid namespace, will find all files that match the provided mask
-     *
-     * @access public
-     * @param string|array $namespaces
-     * @return FilesystemIterator
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function locate($namespaces)
-    {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
-            throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
-        }
-        foreach ((array) $namespaces as $namespace) {
-            foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * given a partial namespace, will find all files in that folder
-     * ** PLZ NOTE **
-     * This assumes that all files within the specified folder should be loaded
-     *
-     * @access protected
-     * @param array $partial_namespace
-     * @return FilesystemIterator
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function FindFQCNsByNamespace($partial_namespace)
-    {
-        $iterator = new FilesystemIterator(
-            $this->getDirectoryFromPartialNamespace($partial_namespace)
-        );
-        foreach ($this->flags as $flag) {
-            $iterator->setFlags($flag);
-        }
-        if (iterator_count($iterator) === 0) {
-            return array();
-        }
-        foreach ($iterator as $file) {
-            $file = \EEH_File::standardise_directory_separators($file);
-            foreach ($this->namespaces as $namespace => $base_dir) {
-                $namespace .= Psr4Autoloader::NS;
-                if (strpos($file, $base_dir) === 0) {
-                    $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
-                        array($base_dir, DS, '.php'),
-                        array($namespace, Psr4Autoloader::NS, ''),
-                        $file
-                    );
-                }
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * getDirectoryFromPartialNamespace
-     *
-     * @access protected
-     * @param  string $partial_namespace almost fully qualified class name ?
-     * @return string
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     */
-    protected function getDirectoryFromPartialNamespace($partial_namespace)
-    {
-        if (empty($partial_namespace)) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        // load our PSR-4 Autoloader so we can get the list of registered namespaces from it
-        $psr4_loader = \EE_Psr4AutoloaderInit::psr4_loader();
-        // breakup the incoming namespace into segments then loop thru them
-        $namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
-        $prefix = null;
-        $namespace_segments_to_try = $namespace_segments;
-        $removed_namespace_segments = [];
-        while (! empty($namespace_segments_to_try)) {
-            $namespace_to_try = implode(Psr4Autoloader::NS, $namespace_segments_to_try);
-            // check if there's a base directory registered for that namespace
-            $prefix = $psr4_loader->prefixes($namespace_to_try . Psr4Autoloader::NS);
-            // nope? then the incoming namespace is invalid
-            if (! empty($prefix) && ! empty($prefix[0])) {
-                break;
-            }
-            array_unshift(
-                $removed_namespace_segments,
-                array_pop($namespace_segments_to_try)
-            );
-        }// nope? then the incoming namespace is invalid
-        if (empty($prefix) || empty($prefix[0])) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        $this->setNamespace($namespace_to_try, $prefix[0]);
-        // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode(DS, $removed_namespace_segments) . DS;
-    }
+	/**
+	 * @var array $FQCNs
+	 */
+	protected $FQCNs = array();
+
+	/**
+	 * @var array $namespaces
+	 */
+	protected $namespaces = array();
+
+
+	/**
+	 * @access protected
+	 * @param string $namespace
+	 * @param string $namespace_base_dir
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setNamespace($namespace, $namespace_base_dir)
+	{
+		if (! is_string($namespace)) {
+			throw new InvalidDataTypeException('$namespace', $namespace, 'string');
+		}
+		if (! is_string($namespace_base_dir)) {
+			throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
+		}
+		$this->namespaces[ $namespace ] = $namespace_base_dir;
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getFQCNs()
+	{
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * @access public
+	 * @return int
+	 */
+	public function count()
+	{
+		return count($this->FQCNs);
+	}
+
+
+	/**
+	 * given a valid namespace, will find all files that match the provided mask
+	 *
+	 * @access public
+	 * @param string|array $namespaces
+	 * @return FilesystemIterator
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function locate($namespaces)
+	{
+		if (! (is_string($namespaces) || is_array($namespaces))) {
+			throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
+		}
+		foreach ((array) $namespaces as $namespace) {
+			foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
+				$this->FQCNs[ $key ] = $file;
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * given a partial namespace, will find all files in that folder
+	 * ** PLZ NOTE **
+	 * This assumes that all files within the specified folder should be loaded
+	 *
+	 * @access protected
+	 * @param array $partial_namespace
+	 * @return FilesystemIterator
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function FindFQCNsByNamespace($partial_namespace)
+	{
+		$iterator = new FilesystemIterator(
+			$this->getDirectoryFromPartialNamespace($partial_namespace)
+		);
+		foreach ($this->flags as $flag) {
+			$iterator->setFlags($flag);
+		}
+		if (iterator_count($iterator) === 0) {
+			return array();
+		}
+		foreach ($iterator as $file) {
+			$file = \EEH_File::standardise_directory_separators($file);
+			foreach ($this->namespaces as $namespace => $base_dir) {
+				$namespace .= Psr4Autoloader::NS;
+				if (strpos($file, $base_dir) === 0) {
+					$this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+						array($base_dir, DS, '.php'),
+						array($namespace, Psr4Autoloader::NS, ''),
+						$file
+					);
+				}
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * getDirectoryFromPartialNamespace
+	 *
+	 * @access protected
+	 * @param  string $partial_namespace almost fully qualified class name ?
+	 * @return string
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 */
+	protected function getDirectoryFromPartialNamespace($partial_namespace)
+	{
+		if (empty($partial_namespace)) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		// load our PSR-4 Autoloader so we can get the list of registered namespaces from it
+		$psr4_loader = \EE_Psr4AutoloaderInit::psr4_loader();
+		// breakup the incoming namespace into segments then loop thru them
+		$namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
+		$prefix = null;
+		$namespace_segments_to_try = $namespace_segments;
+		$removed_namespace_segments = [];
+		while (! empty($namespace_segments_to_try)) {
+			$namespace_to_try = implode(Psr4Autoloader::NS, $namespace_segments_to_try);
+			// check if there's a base directory registered for that namespace
+			$prefix = $psr4_loader->prefixes($namespace_to_try . Psr4Autoloader::NS);
+			// nope? then the incoming namespace is invalid
+			if (! empty($prefix) && ! empty($prefix[0])) {
+				break;
+			}
+			array_unshift(
+				$removed_namespace_segments,
+				array_pop($namespace_segments_to_try)
+			);
+		}// nope? then the incoming namespace is invalid
+		if (empty($prefix) || empty($prefix[0])) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		$this->setNamespace($namespace_to_try, $prefix[0]);
+		// but if it's good, add that base directory to the rest of the path, and return it
+		return $prefix[0] . implode(DS, $removed_namespace_segments) . DS;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -36,13 +36,13 @@ 
      */
     protected function setNamespace($namespace, $namespace_base_dir)
     {
-        if (! is_string($namespace)) {
+        if ( ! is_string($namespace)) {
             throw new InvalidDataTypeException('$namespace', $namespace, 'string');
         }
-        if (! is_string($namespace_base_dir)) {
+        if ( ! is_string($namespace_base_dir)) {
             throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
         }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
+        $this->namespaces[$namespace] = $namespace_base_dir;
     }
 
 
@@ -77,12 +77,12 @@ 
      */
     public function locate($namespaces)
     {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
+        if ( ! (is_string($namespaces) || is_array($namespaces))) {
             throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
         }
         foreach ((array) $namespaces as $namespace) {
             foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
+                $this->FQCNs[$key] = $file;
             }
         }
         return $this->FQCNs;
@@ -118,7 +118,7 @@ 
             foreach ($this->namespaces as $namespace => $base_dir) {
                 $namespace .= Psr4Autoloader::NS;
                 if (strpos($file, $base_dir) === 0) {
-                    $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+                    $this->FQCNs[] = Psr4Autoloader::NS.str_replace(
                         array($base_dir, DS, '.php'),
                         array($namespace, Psr4Autoloader::NS, ''),
                         $file
@@ -151,12 +151,12 @@ 
         $prefix = null;
         $namespace_segments_to_try = $namespace_segments;
         $removed_namespace_segments = [];
-        while (! empty($namespace_segments_to_try)) {
+        while ( ! empty($namespace_segments_to_try)) {
             $namespace_to_try = implode(Psr4Autoloader::NS, $namespace_segments_to_try);
             // check if there's a base directory registered for that namespace
-            $prefix = $psr4_loader->prefixes($namespace_to_try . Psr4Autoloader::NS);
+            $prefix = $psr4_loader->prefixes($namespace_to_try.Psr4Autoloader::NS);
             // nope? then the incoming namespace is invalid
-            if (! empty($prefix) && ! empty($prefix[0])) {
+            if ( ! empty($prefix) && ! empty($prefix[0])) {
                 break;
             }
             array_unshift(
@@ -169,6 +169,6 @@ 
         }
         $this->setNamespace($namespace_to_try, $prefix[0]);
         // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode(DS, $removed_namespace_segments) . DS;
+        return $prefix[0].implode(DS, $removed_namespace_segments).DS;
     }
 }

core/services/json/JsonSerializableAndUnserializable.php

Indentation +14 added lines, -14 removed lines

@@ -15,21 +15,21 @@
  */
 interface JsonSerializableAndUnserializable
 {
-    /**
-     * Creates a simple PHP array or stdClass from this object's properties, which can be easily serialized using
-     * wp_json_serialize().
-     * @since $VID:$
-     * @return mixed
-     */
-    public function toJsonSerializableData();
+	/**
+	 * Creates a simple PHP array or stdClass from this object's properties, which can be easily serialized using
+	 * wp_json_serialize().
+	 * @since $VID:$
+	 * @return mixed
+	 */
+	public function toJsonSerializableData();
 
-    /**
-     * Initializes this object from data
-     * @since $VID:$
-     * @param mixed $data
-     * @return boolean success
-     */
-    public function fromJsonSerializedData($data);
+	/**
+	 * Initializes this object from data
+	 * @since $VID:$
+	 * @param mixed $data
+	 * @return boolean success
+	 */
+	public function fromJsonSerializedData($data);
 }
 // End of file JsonSerializableAndUnserializable.php
 // Location: EventEspresso\core\services\json/JsonSerializableAndUnserializable.php

core/libraries/form_sections/form_handlers/FormHandler.php

Indentation +637 added lines, -637 removed lines

@@ -29,641 +29,641 @@
 abstract class FormHandler implements FormHandlerInterface
 {
 
-    /**
-     * will add opening and closing HTML form tags as well as a submit button
-     */
-    const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
-
-    /**
-     * will add opening and closing HTML form tags but NOT a submit button
-     */
-    const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags but will add a submit button
-     */
-    const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags NOR a submit button
-     */
-    const DO_NOT_SETUP_FORM = 'do_not_setup_form';
-
-    /**
-     * if set to false, then this form has no displayable content,
-     * and will only be used for processing data sent passed via GET or POST
-     * defaults to true ( ie: form has displayable content )
-     *
-     * @var boolean $displayable
-     */
-    private $displayable = true;
-
-    /**
-     * @var string $form_name
-     */
-    private $form_name;
-
-    /**
-     * @var string $admin_name
-     */
-    private $admin_name;
-
-    /**
-     * @var string $slug
-     */
-    private $slug;
-
-    /**
-     * @var string $submit_btn_text
-     */
-    private $submit_btn_text;
-
-    /**
-     * @var string $form_action
-     */
-    private $form_action;
-
-    /**
-     * form params in key value pairs
-     * can be added to form action URL or as hidden inputs
-     *
-     * @var array $form_args
-     */
-    private $form_args = array();
-
-    /**
-     * value of one of the string constant above
-     *
-     * @var string $form_config
-     */
-    private $form_config;
-
-    /**
-     * whether or not the form was determined to be invalid
-     *
-     * @var boolean $form_has_errors
-     */
-    private $form_has_errors;
-
-    /**
-     * the absolute top level form section being used on the page
-     *
-     * @var EE_Form_Section_Proper $form
-     */
-    private $form;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-    // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
-    /**
-     * Form constructor.
-     *
-     * @param string      $form_name
-     * @param string      $admin_name
-     * @param string      $slug
-     * @param string      $form_action
-     * @param string      $form_config
-     * @param EE_Registry $registry
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $form_name,
-        $admin_name,
-        $slug,
-        $form_action = '',
-        $form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-        EE_Registry $registry
-    ) {
-        $this->setFormName($form_name);
-        $this->setAdminName($admin_name);
-        $this->setSlug($slug);
-        $this->setFormAction($form_action);
-        $this->setFormConfig($form_config);
-        $this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
-        $this->registry = $registry;
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function getFormConfigConstants()
-    {
-        return array(
-            FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-            FormHandler::ADD_FORM_TAGS_ONLY,
-            FormHandler::ADD_FORM_SUBMIT_ONLY,
-            FormHandler::DO_NOT_SETUP_FORM,
-        );
-    }
-
-
-    /**
-     * @param bool $for_display
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws LogicException
-     */
-    public function form($for_display = false)
-    {
-        if (! $this->formIsValid()) {
-            return null;
-        }
-        if ($for_display) {
-            $form_config = $this->formConfig();
-            if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-                || $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
-            ) {
-                $this->appendSubmitButton();
-                $this->clearFormButtonFloats();
-            }
-        }
-        return $this->form;
-    }
-
-
-    /**
-     * @return boolean
-     * @throws LogicException
-     */
-    public function formIsValid()
-    {
-        if ($this->form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        $form = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
-            $this->generate(),
-            $this
-        );
-        if ($this->verifyForm($form)) {
-            $this->setForm($form);
-        }
-        return true;
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper|null $form
-     * @return bool
-     * @throws LogicException
-     */
-    public function verifyForm(EE_Form_Section_Proper $form = null)
-    {
-        $form = $form !== null ? $form : $this->form;
-        if ($form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        throw new LogicException(
-            sprintf(
-                esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
-                $this->form_name,
-                var_export($form, true)
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper $form
-     */
-    public function setForm(EE_Form_Section_Proper $form)
-    {
-        $this->form = $form;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function displayable()
-    {
-        return $this->displayable;
-    }
-
-
-    /**
-     * @param boolean $displayable
-     */
-    public function setDisplayable($displayable = false)
-    {
-        $this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * a public name for the form that can be displayed on the frontend of a site
-     *
-     * @return string
-     */
-    public function formName()
-    {
-        return $this->form_name;
-    }
-
-
-    /**
-     * @param string $form_name
-     * @throws InvalidDataTypeException
-     */
-    public function setFormName($form_name)
-    {
-        if (! is_string($form_name)) {
-            throw new InvalidDataTypeException('$form_name', $form_name, 'string');
-        }
-        $this->form_name = $form_name;
-    }
-
-
-    /**
-     * a public name for the form that can be displayed, but only in the admin
-     *
-     * @return string
-     */
-    public function adminName()
-    {
-        return $this->admin_name;
-    }
-
-
-    /**
-     * @param string $admin_name
-     * @throws InvalidDataTypeException
-     */
-    public function setAdminName($admin_name)
-    {
-        if (! is_string($admin_name)) {
-            throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
-        }
-        $this->admin_name = $admin_name;
-    }
-
-
-    /**
-     * a URL friendly string that can be used for identifying the form
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->slug;
-    }
-
-
-    /**
-     * @param string $slug
-     * @throws InvalidDataTypeException
-     */
-    public function setSlug($slug)
-    {
-        if (! is_string($slug)) {
-            throw new InvalidDataTypeException('$slug', $slug, 'string');
-        }
-        $this->slug = $slug;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function submitBtnText()
-    {
-        return $this->submit_btn_text;
-    }
-
-
-    /**
-     * @param string $submit_btn_text
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function setSubmitBtnText($submit_btn_text)
-    {
-        if (! is_string($submit_btn_text)) {
-            throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
-        }
-        if (empty($submit_btn_text)) {
-            throw new InvalidArgumentException(
-                esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
-            );
-        }
-        $this->submit_btn_text = $submit_btn_text;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formAction()
-    {
-        return ! empty($this->form_args)
-            ? add_query_arg($this->form_args, $this->form_action)
-            : $this->form_action;
-    }
-
-
-    /**
-     * @param string $form_action
-     * @throws InvalidDataTypeException
-     */
-    public function setFormAction($form_action)
-    {
-        if (! is_string($form_action)) {
-            throw new InvalidDataTypeException('$form_action', $form_action, 'string');
-        }
-        $this->form_action = $form_action;
-    }
-
-
-    /**
-     * @param array $form_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function addFormActionArgs($form_args = array())
-    {
-        if (is_object($form_args)) {
-            throw new InvalidDataTypeException(
-                '$form_args',
-                $form_args,
-                'anything other than an object was expected.'
-            );
-        }
-        if (empty($form_args)) {
-            throw new InvalidArgumentException(
-                esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
-            );
-        }
-        $this->form_args = array_merge($this->form_args, $form_args);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formConfig()
-    {
-        return $this->form_config;
-    }
-
-
-    /**
-     * @param string $form_config
-     * @throws DomainException
-     */
-    public function setFormConfig($form_config)
-    {
-        if (! in_array(
-            $form_config,
-            array(
-                FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-                FormHandler::ADD_FORM_TAGS_ONLY,
-                FormHandler::ADD_FORM_SUBMIT_ONLY,
-                FormHandler::DO_NOT_SETUP_FORM,
-            ),
-            true
-        )
-        ) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
-                        'event_espresso'
-                    ),
-                    $form_config
-                )
-            );
-        }
-        $this->form_config = $form_config;
-    }
-
-
-    /**
-     * called after the form is instantiated
-     * and used for performing any logic that needs to occur early
-     * before any of the other methods are called.
-     * returns true if everything is ok to proceed,
-     * and false if no further form logic should be implemented
-     *
-     * @return boolean
-     */
-    public function initialize()
-    {
-        $this->form_has_errors = EE_Error::has_error(true);
-        return true;
-    }
-
-
-    /**
-     * used for setting up css and js
-     *
-     * @return void
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function enqueueStylesAndScripts()
-    {
-        $this->form()->enqueue_js();
-    }
-
-
-    /**
-     * creates and returns the actual form
-     *
-     * @return EE_Form_Section_Proper
-     */
-    abstract public function generate();
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Submit"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateSubmitButton($text = '')
-    {
-        $text = ! empty($text) ? $text : $this->submitBtnText();
-        return new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(),
-                'html_id'               => 'ee-form-submit-' . $this->slug(),
-                'html_class'            => 'ee-form-submit',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => $text,
-            )
-        );
-    }
-
-
-    /**
-     * calls generateSubmitButton() and appends it onto the form along with a float clearing div
-     *
-     * @param string $text
-     * @return void
-     * @throws EE_Error
-     */
-    public function appendSubmitButton($text = '')
-    {
-        if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
-            return;
-        }
-        $this->form->add_subsections(
-            array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
-            null,
-            false
-        );
-    }
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Cancel"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateCancelButton($text = '')
-    {
-        $cancel_button = new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
-                'html_id'               => 'ee-cancel-form-' . $this->slug(),
-                'html_class'            => 'ee-cancel-form',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
-            )
-        );
-        $cancel_button->set_button_css_attributes(false);
-        return $cancel_button;
-    }
-
-
-    /**
-     * appends a float clearing div onto end of form
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function clearFormButtonFloats()
-    {
-        $this->form->add_subsections(
-            array(
-                'clear-submit-btn-float' => new EE_Form_Section_HTML(
-                    EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
-                ),
-            ),
-            null,
-            false
-        );
-    }
-
-
-    /**
-     * takes the generated form and displays it along with ony other non-form HTML that may be required
-     * returns a string of HTML that can be directly echoed in a template
-     *
-     * @return string
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function display()
-    {
-        $form_html = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
-            ''
-        );
-        $form_config = $this->formConfig();
-        if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            if ($this->requiresMultipartEnctype()) {
-                $additional_props = 'enctype="multipart/form-data"';
-            } else {
-                $additional_props = '';
-            }
-            $form_html .= $this->form()->form_open(
-                $this->formAction(),
-                'POST',
-                $additional_props
-            );
-        }
-        $form_html .= $this->form(true)->get_html();
-        if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $form_html .= $this->form()->form_close();
-        }
-        $form_html .= apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
-            ''
-        );
-        return $form_html;
-    }
-
-    /**
-     * Determines if this form needs "
-     * @since $VID:$
-     * @return bool
-     * @throws EE_Error
-     */
-    public function requiresMultipartEnctype()
-    {
-        foreach ($this->form()->inputs_in_subsections() as $input) {
-            if ($input instanceof EE_File_Input) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * handles processing the form submission
-     * returns true or false depending on whether the form was processed successfully or not
-     *
-     * @param array $submitted_form_data
-     * @return array
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws EE_Error
-     * @throws LogicException
-     * @throws InvalidFormSubmissionException
-     */
-    public function process($submitted_form_data = array())
-    {
-        if (! $this->form()->was_submitted($submitted_form_data)) {
-            throw new InvalidFormSubmissionException($this->form_name);
-        }
-        $this->form(true)->receive_form_submission($submitted_form_data);
-        if (! $this->form()->is_valid()) {
-            throw new InvalidFormSubmissionException(
-                $this->form_name,
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
-                        'event_espresso'
-                    ),
-                    $this->form_name,
-                    '<br />',
-                    implode('<br />', $this->form()->get_validation_errors_accumulated())
-                )
-            );
-        }
-        return apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__process__valid_data',
-            $this->form()->valid_data(),
-            $this
-        );
-    }
+	/**
+	 * will add opening and closing HTML form tags as well as a submit button
+	 */
+	const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
+
+	/**
+	 * will add opening and closing HTML form tags but NOT a submit button
+	 */
+	const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags but will add a submit button
+	 */
+	const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags NOR a submit button
+	 */
+	const DO_NOT_SETUP_FORM = 'do_not_setup_form';
+
+	/**
+	 * if set to false, then this form has no displayable content,
+	 * and will only be used for processing data sent passed via GET or POST
+	 * defaults to true ( ie: form has displayable content )
+	 *
+	 * @var boolean $displayable
+	 */
+	private $displayable = true;
+
+	/**
+	 * @var string $form_name
+	 */
+	private $form_name;
+
+	/**
+	 * @var string $admin_name
+	 */
+	private $admin_name;
+
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
+
+	/**
+	 * @var string $submit_btn_text
+	 */
+	private $submit_btn_text;
+
+	/**
+	 * @var string $form_action
+	 */
+	private $form_action;
+
+	/**
+	 * form params in key value pairs
+	 * can be added to form action URL or as hidden inputs
+	 *
+	 * @var array $form_args
+	 */
+	private $form_args = array();
+
+	/**
+	 * value of one of the string constant above
+	 *
+	 * @var string $form_config
+	 */
+	private $form_config;
+
+	/**
+	 * whether or not the form was determined to be invalid
+	 *
+	 * @var boolean $form_has_errors
+	 */
+	private $form_has_errors;
+
+	/**
+	 * the absolute top level form section being used on the page
+	 *
+	 * @var EE_Form_Section_Proper $form
+	 */
+	private $form;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+	// phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
+	/**
+	 * Form constructor.
+	 *
+	 * @param string      $form_name
+	 * @param string      $admin_name
+	 * @param string      $slug
+	 * @param string      $form_action
+	 * @param string      $form_config
+	 * @param EE_Registry $registry
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$form_name,
+		$admin_name,
+		$slug,
+		$form_action = '',
+		$form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+		EE_Registry $registry
+	) {
+		$this->setFormName($form_name);
+		$this->setAdminName($admin_name);
+		$this->setSlug($slug);
+		$this->setFormAction($form_action);
+		$this->setFormConfig($form_config);
+		$this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
+		$this->registry = $registry;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function getFormConfigConstants()
+	{
+		return array(
+			FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+			FormHandler::ADD_FORM_TAGS_ONLY,
+			FormHandler::ADD_FORM_SUBMIT_ONLY,
+			FormHandler::DO_NOT_SETUP_FORM,
+		);
+	}
+
+
+	/**
+	 * @param bool $for_display
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws LogicException
+	 */
+	public function form($for_display = false)
+	{
+		if (! $this->formIsValid()) {
+			return null;
+		}
+		if ($for_display) {
+			$form_config = $this->formConfig();
+			if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+				|| $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
+			) {
+				$this->appendSubmitButton();
+				$this->clearFormButtonFloats();
+			}
+		}
+		return $this->form;
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws LogicException
+	 */
+	public function formIsValid()
+	{
+		if ($this->form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		$form = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
+			$this->generate(),
+			$this
+		);
+		if ($this->verifyForm($form)) {
+			$this->setForm($form);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper|null $form
+	 * @return bool
+	 * @throws LogicException
+	 */
+	public function verifyForm(EE_Form_Section_Proper $form = null)
+	{
+		$form = $form !== null ? $form : $this->form;
+		if ($form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		throw new LogicException(
+			sprintf(
+				esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
+				$this->form_name,
+				var_export($form, true)
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper $form
+	 */
+	public function setForm(EE_Form_Section_Proper $form)
+	{
+		$this->form = $form;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function displayable()
+	{
+		return $this->displayable;
+	}
+
+
+	/**
+	 * @param boolean $displayable
+	 */
+	public function setDisplayable($displayable = false)
+	{
+		$this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * a public name for the form that can be displayed on the frontend of a site
+	 *
+	 * @return string
+	 */
+	public function formName()
+	{
+		return $this->form_name;
+	}
+
+
+	/**
+	 * @param string $form_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormName($form_name)
+	{
+		if (! is_string($form_name)) {
+			throw new InvalidDataTypeException('$form_name', $form_name, 'string');
+		}
+		$this->form_name = $form_name;
+	}
+
+
+	/**
+	 * a public name for the form that can be displayed, but only in the admin
+	 *
+	 * @return string
+	 */
+	public function adminName()
+	{
+		return $this->admin_name;
+	}
+
+
+	/**
+	 * @param string $admin_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setAdminName($admin_name)
+	{
+		if (! is_string($admin_name)) {
+			throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
+		}
+		$this->admin_name = $admin_name;
+	}
+
+
+	/**
+	 * a URL friendly string that can be used for identifying the form
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->slug;
+	}
+
+
+	/**
+	 * @param string $slug
+	 * @throws InvalidDataTypeException
+	 */
+	public function setSlug($slug)
+	{
+		if (! is_string($slug)) {
+			throw new InvalidDataTypeException('$slug', $slug, 'string');
+		}
+		$this->slug = $slug;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function submitBtnText()
+	{
+		return $this->submit_btn_text;
+	}
+
+
+	/**
+	 * @param string $submit_btn_text
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function setSubmitBtnText($submit_btn_text)
+	{
+		if (! is_string($submit_btn_text)) {
+			throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
+		}
+		if (empty($submit_btn_text)) {
+			throw new InvalidArgumentException(
+				esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
+			);
+		}
+		$this->submit_btn_text = $submit_btn_text;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formAction()
+	{
+		return ! empty($this->form_args)
+			? add_query_arg($this->form_args, $this->form_action)
+			: $this->form_action;
+	}
+
+
+	/**
+	 * @param string $form_action
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormAction($form_action)
+	{
+		if (! is_string($form_action)) {
+			throw new InvalidDataTypeException('$form_action', $form_action, 'string');
+		}
+		$this->form_action = $form_action;
+	}
+
+
+	/**
+	 * @param array $form_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function addFormActionArgs($form_args = array())
+	{
+		if (is_object($form_args)) {
+			throw new InvalidDataTypeException(
+				'$form_args',
+				$form_args,
+				'anything other than an object was expected.'
+			);
+		}
+		if (empty($form_args)) {
+			throw new InvalidArgumentException(
+				esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
+			);
+		}
+		$this->form_args = array_merge($this->form_args, $form_args);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formConfig()
+	{
+		return $this->form_config;
+	}
+
+
+	/**
+	 * @param string $form_config
+	 * @throws DomainException
+	 */
+	public function setFormConfig($form_config)
+	{
+		if (! in_array(
+			$form_config,
+			array(
+				FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+				FormHandler::ADD_FORM_TAGS_ONLY,
+				FormHandler::ADD_FORM_SUBMIT_ONLY,
+				FormHandler::DO_NOT_SETUP_FORM,
+			),
+			true
+		)
+		) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
+						'event_espresso'
+					),
+					$form_config
+				)
+			);
+		}
+		$this->form_config = $form_config;
+	}
+
+
+	/**
+	 * called after the form is instantiated
+	 * and used for performing any logic that needs to occur early
+	 * before any of the other methods are called.
+	 * returns true if everything is ok to proceed,
+	 * and false if no further form logic should be implemented
+	 *
+	 * @return boolean
+	 */
+	public function initialize()
+	{
+		$this->form_has_errors = EE_Error::has_error(true);
+		return true;
+	}
+
+
+	/**
+	 * used for setting up css and js
+	 *
+	 * @return void
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function enqueueStylesAndScripts()
+	{
+		$this->form()->enqueue_js();
+	}
+
+
+	/**
+	 * creates and returns the actual form
+	 *
+	 * @return EE_Form_Section_Proper
+	 */
+	abstract public function generate();
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Submit"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateSubmitButton($text = '')
+	{
+		$text = ! empty($text) ? $text : $this->submitBtnText();
+		return new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(),
+				'html_id'               => 'ee-form-submit-' . $this->slug(),
+				'html_class'            => 'ee-form-submit',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => $text,
+			)
+		);
+	}
+
+
+	/**
+	 * calls generateSubmitButton() and appends it onto the form along with a float clearing div
+	 *
+	 * @param string $text
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function appendSubmitButton($text = '')
+	{
+		if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
+			return;
+		}
+		$this->form->add_subsections(
+			array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
+			null,
+			false
+		);
+	}
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Cancel"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateCancelButton($text = '')
+	{
+		$cancel_button = new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
+				'html_id'               => 'ee-cancel-form-' . $this->slug(),
+				'html_class'            => 'ee-cancel-form',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
+			)
+		);
+		$cancel_button->set_button_css_attributes(false);
+		return $cancel_button;
+	}
+
+
+	/**
+	 * appends a float clearing div onto end of form
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function clearFormButtonFloats()
+	{
+		$this->form->add_subsections(
+			array(
+				'clear-submit-btn-float' => new EE_Form_Section_HTML(
+					EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
+				),
+			),
+			null,
+			false
+		);
+	}
+
+
+	/**
+	 * takes the generated form and displays it along with ony other non-form HTML that may be required
+	 * returns a string of HTML that can be directly echoed in a template
+	 *
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function display()
+	{
+		$form_html = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
+			''
+		);
+		$form_config = $this->formConfig();
+		if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			if ($this->requiresMultipartEnctype()) {
+				$additional_props = 'enctype="multipart/form-data"';
+			} else {
+				$additional_props = '';
+			}
+			$form_html .= $this->form()->form_open(
+				$this->formAction(),
+				'POST',
+				$additional_props
+			);
+		}
+		$form_html .= $this->form(true)->get_html();
+		if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$form_html .= $this->form()->form_close();
+		}
+		$form_html .= apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
+			''
+		);
+		return $form_html;
+	}
+
+	/**
+	 * Determines if this form needs "
+	 * @since $VID:$
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function requiresMultipartEnctype()
+	{
+		foreach ($this->form()->inputs_in_subsections() as $input) {
+			if ($input instanceof EE_File_Input) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * handles processing the form submission
+	 * returns true or false depending on whether the form was processed successfully or not
+	 *
+	 * @param array $submitted_form_data
+	 * @return array
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws LogicException
+	 * @throws InvalidFormSubmissionException
+	 */
+	public function process($submitted_form_data = array())
+	{
+		if (! $this->form()->was_submitted($submitted_form_data)) {
+			throw new InvalidFormSubmissionException($this->form_name);
+		}
+		$this->form(true)->receive_form_submission($submitted_form_data);
+		if (! $this->form()->is_valid()) {
+			throw new InvalidFormSubmissionException(
+				$this->form_name,
+				sprintf(
+					esc_html__(
+						'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
+						'event_espresso'
+					),
+					$this->form_name,
+					'<br />',
+					implode('<br />', $this->form()->get_validation_errors_accumulated())
+				)
+			);
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__process__valid_data',
+			$this->form()->valid_data(),
+			$this
+		);
+	}
 }

core/libraries/form_sections/inputs/EE_File_Input.input.php

Indentation +97 added lines, -97 removed lines

@@ -17,108 +17,108 @@
  */
 class EE_File_Input extends EE_Form_Input_Base
 {
-    /**
-     * @var array
-     */
-    protected $allowed_file_extensions;
+	/**
+	 * @var array
+	 */
+	protected $allowed_file_extensions;
 
-    /**
-     * @var
-     */
-    protected $allowed_mime_types;
+	/**
+	 * @var
+	 */
+	protected $allowed_mime_types;
 
-    /**
-     * @param array $options
-     * @throws InvalidArgumentException
-     */
-    public function __construct($options = array())
-    {
-        if (isset($options['allowed_file_extensions'])) {
-            if (!is_array($options['allowed_file_extensions'])) {
-                throw new InvalidArgumentException(esc_html__('A valid allowed_file_extensions array was not provided to EE_File_Input', 'event_espresso'));
-            }
-            $this->allowed_file_extensions = $options['allowed_file_extensions'];
-        } else {
-            $this->allowed_file_extensions = ['csv'];
-        }
-        if (isset($options['allowed_mime_types'])) {
-            if (!is_array($options['allowed_mime_types'])) {
-                throw new InvalidArgumentException(esc_html__('A valid allowed_mime_types array was not provided to EE_File_Input', 'event_espresso'));
-            }
-            $this->allowed_mime_types = $options['allowed_file_extensions'];
-        } else {
-            $this->allowed_mime_types = ['text/csv'];
-        }
+	/**
+	 * @param array $options
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($options = array())
+	{
+		if (isset($options['allowed_file_extensions'])) {
+			if (!is_array($options['allowed_file_extensions'])) {
+				throw new InvalidArgumentException(esc_html__('A valid allowed_file_extensions array was not provided to EE_File_Input', 'event_espresso'));
+			}
+			$this->allowed_file_extensions = $options['allowed_file_extensions'];
+		} else {
+			$this->allowed_file_extensions = ['csv'];
+		}
+		if (isset($options['allowed_mime_types'])) {
+			if (!is_array($options['allowed_mime_types'])) {
+				throw new InvalidArgumentException(esc_html__('A valid allowed_mime_types array was not provided to EE_File_Input', 'event_espresso'));
+			}
+			$this->allowed_mime_types = $options['allowed_file_extensions'];
+		} else {
+			$this->allowed_mime_types = ['text/csv'];
+		}
 
-        $this->_set_display_strategy(new EE_File_Input_Display_Strategy());
-        $this->_set_normalization_strategy(new EE_File_Normalization());
-        $this->add_validation_strategy(
-            new EE_Text_Validation_Strategy(
-                sprintf(
-                    // translators: %1$s is a list of allowed file extensions.
-                    esc_html__('Please provide a file of the requested filetype: %1$s', 'event_espresso'),
-                    implode(', ', $this->allowed_file_extensions)
-                ),
-                '~.*\.(' . implode('|', $this->allowed_file_extensions) . ')$~'
-            )
-        );
-        parent::__construct($options);
+		$this->_set_display_strategy(new EE_File_Input_Display_Strategy());
+		$this->_set_normalization_strategy(new EE_File_Normalization());
+		$this->add_validation_strategy(
+			new EE_Text_Validation_Strategy(
+				sprintf(
+					// translators: %1$s is a list of allowed file extensions.
+					esc_html__('Please provide a file of the requested filetype: %1$s', 'event_espresso'),
+					implode(', ', $this->allowed_file_extensions)
+				),
+				'~.*\.(' . implode('|', $this->allowed_file_extensions) . ')$~'
+			)
+		);
+		parent::__construct($options);
 
 //        It would be great to add this HTML attribute, but jQuery validate chokes on it.
-        $this->set_other_html_attributes(
-            $this->other_html_attributes()
-            . ' extension="'
-            . implode(
-                ',',
-                //                array_merge(
-                //                    array_map(
-                //                        function ($mime_type) {
-                //                            if(strpos($mime_type, '/') === false) {
-                //                                return $mime_type . '/*';
-                //                            } else {
-                //                                return $mime_type;
-                //                            }
-                //
-                //                        },
-                //                        $this->allowed_mime_types
-                //                    )
-                    array_map(
-                        function ($file_extension) {
-                            return  $file_extension;
-                        },
-                        $this->allowed_file_extensions
-                    )
-                //                )
-            )
-            . '"'
-        );
-    }
+		$this->set_other_html_attributes(
+			$this->other_html_attributes()
+			. ' extension="'
+			. implode(
+				',',
+				//                array_merge(
+				//                    array_map(
+				//                        function ($mime_type) {
+				//                            if(strpos($mime_type, '/') === false) {
+				//                                return $mime_type . '/*';
+				//                            } else {
+				//                                return $mime_type;
+				//                            }
+				//
+				//                        },
+				//                        $this->allowed_mime_types
+				//                    )
+					array_map(
+						function ($file_extension) {
+							return  $file_extension;
+						},
+						$this->allowed_file_extensions
+					)
+				//                )
+			)
+			. '"'
+		);
+	}
 
-    /**
-     * Takes into account that $_FILES does a weird thing when you have hierarchical form names (eg `<input type="file"
-     * name="my[hierarchical][form]">`): it leaves the top-level form part alone, but replaces the SECOND part with
-     * "name", "size", "temp_file", etc. So that file's data is located at "my[name][hierarchical][form]",
-     * "my[size][hierarchical][form]", "my[temp_name][hierarchical][form]", etc. It's really weird.
-     * @since $VID:$
-     * @param array $req_data
-     * @return array|mixed|NULL
-     * @throws EE_Error
-     */
-    public function find_form_data_for_this_section($req_data)
-    {
-        // ignore $req_data. Files are in the files data handler.
-        $fileDataHandler = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\files\FilesDataHandler');
-        return $fileDataHandler->getFileObject($this->html_name());
-    }
+	/**
+	 * Takes into account that $_FILES does a weird thing when you have hierarchical form names (eg `<input type="file"
+	 * name="my[hierarchical][form]">`): it leaves the top-level form part alone, but replaces the SECOND part with
+	 * "name", "size", "temp_file", etc. So that file's data is located at "my[name][hierarchical][form]",
+	 * "my[size][hierarchical][form]", "my[temp_name][hierarchical][form]", etc. It's really weird.
+	 * @since $VID:$
+	 * @param array $req_data
+	 * @return array|mixed|NULL
+	 * @throws EE_Error
+	 */
+	public function find_form_data_for_this_section($req_data)
+	{
+		// ignore $req_data. Files are in the files data handler.
+		$fileDataHandler = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\files\FilesDataHandler');
+		return $fileDataHandler->getFileObject($this->html_name());
+	}
 
-    /**
-     * Don't transform the file submission object into a string, thanks.
-     *
-     * @param string $value
-     * @return null|string
-     */
-    protected function _sanitize($value)
-    {
-        return $value;
-    }
+	/**
+	 * Don't transform the file submission object into a string, thanks.
+	 *
+	 * @param string $value
+	 * @return null|string
+	 */
+	protected function _sanitize($value)
+	{
+		return $value;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -34,7 +34,7 @@ 
     public function __construct($options = array())
     {
         if (isset($options['allowed_file_extensions'])) {
-            if (!is_array($options['allowed_file_extensions'])) {
+            if ( ! is_array($options['allowed_file_extensions'])) {
                 throw new InvalidArgumentException(esc_html__('A valid allowed_file_extensions array was not provided to EE_File_Input', 'event_espresso'));
             }
             $this->allowed_file_extensions = $options['allowed_file_extensions'];
@@ -42,7 +42,7 @@ 
             $this->allowed_file_extensions = ['csv'];
         }
         if (isset($options['allowed_mime_types'])) {
-            if (!is_array($options['allowed_mime_types'])) {
+            if ( ! is_array($options['allowed_mime_types'])) {
                 throw new InvalidArgumentException(esc_html__('A valid allowed_mime_types array was not provided to EE_File_Input', 'event_espresso'));
             }
             $this->allowed_mime_types = $options['allowed_file_extensions'];
@@ -59,7 +59,7 @@ 
                     esc_html__('Please provide a file of the requested filetype: %1$s', 'event_espresso'),
                     implode(', ', $this->allowed_file_extensions)
                 ),
-                '~.*\.(' . implode('|', $this->allowed_file_extensions) . ')$~'
+                '~.*\.('.implode('|', $this->allowed_file_extensions).')$~'
             )
         );
         parent::__construct($options);
@@ -83,7 +83,7 @@ 
                 //                        $this->allowed_mime_types
                 //                    )
                     array_map(
-                        function ($file_extension) {
+                        function($file_extension) {
                             return  $file_extension;
                         },
                         $this->allowed_file_extensions

core/libraries/form_sections/strategies/normalization/EE_File_Normalization.strategy.php

Indentation +31 added lines, -31 removed lines

@@ -13,37 +13,37 @@
 class EE_File_Normalization extends EE_Normalization_Strategy_Base
 {
 
-    /**
-     * Convert the $_FILES inputted data into a well-defined object.
-     * @param string $value_to_normalize
-     * @return FileSubmissionInterface
-     */
-    public function normalize($value_to_normalize)
-    {
-        if ($value_to_normalize instanceof FileSubmissionInterface || is_null($value_to_normalize)) {
-            return $value_to_normalize;
-        } else {
-            throw new EE_Validation_Error(
-                esc_html__('The file input has an inavlid format.', 'event_espresso')
-            );
-        }
-    }
+	/**
+	 * Convert the $_FILES inputted data into a well-defined object.
+	 * @param string $value_to_normalize
+	 * @return FileSubmissionInterface
+	 */
+	public function normalize($value_to_normalize)
+	{
+		if ($value_to_normalize instanceof FileSubmissionInterface || is_null($value_to_normalize)) {
+			return $value_to_normalize;
+		} else {
+			throw new EE_Validation_Error(
+				esc_html__('The file input has an inavlid format.', 'event_espresso')
+			);
+		}
+	}
 
 
-    /**
-     * Convert the object back into a string of the filename.
-     *
-     * @param string $normalized_value
-     * @return string
-     */
-    public function unnormalize($normalized_value)
-    {
-        if ($normalized_value instanceof FileSubmissionInterface || is_null($normalized_value)) {
-            // Leave it as the object, it can be treated like a string because it
-            // overrides __toString()
-            return $normalized_value;
-        } else {
-            return (string) $normalized_value;
-        }
-    }
+	/**
+	 * Convert the object back into a string of the filename.
+	 *
+	 * @param string $normalized_value
+	 * @return string
+	 */
+	public function unnormalize($normalized_value)
+	{
+		if ($normalized_value instanceof FileSubmissionInterface || is_null($normalized_value)) {
+			// Leave it as the object, it can be treated like a string because it
+			// overrides __toString()
+			return $normalized_value;
+		} else {
+			return (string) $normalized_value;
+		}
+	}
 }