eventespresso / event-espresso-core

core/services/request/files/FileSubmissionInterface.php

Indentation +30 added lines, -30 removed lines

@@ -15,36 +15,36 @@
 interface FileSubmissionInterface
 {
 
-    /**
-     * @return string
-     */
-    public function getName();
-
-    /**
-     * @return string
-     */
-    public function getType();
-
-    /**
-     * @return int
-     */
-    public function getSize();
-
-    /**
-     * @return string
-     */
-    public function getTmpFile();
-
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    public function __toString();
-
-    /**
-     * @return string
-     */
-    public function getErrorCode();
+	/**
+	 * @return string
+	 */
+	public function getName();
+
+	/**
+	 * @return string
+	 */
+	public function getType();
+
+	/**
+	 * @return int
+	 */
+	public function getSize();
+
+	/**
+	 * @return string
+	 */
+	public function getTmpFile();
+
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function __toString();
+
+	/**
+	 * @return string
+	 */
+	public function getErrorCode();
 }
 // End of file FileSubmissionInterface.php
 // Location: EventEspresso\core\services\request\files/FileSubmissionInterface.php

core/services/request/files/FilesDataHandler.php

Indentation +242 added lines, -242 removed lines

@@ -38,260 +38,260 @@
  */
 class FilesDataHandler
 {
-    /**
-     * @var Request
-     */
-    protected $request;
+	/**
+	 * @var Request
+	 */
+	protected $request;
 
-    /**
-     * @var CollectionInterface | FileSubmissionInterface[]
-     */
-    protected $file_objects;
+	/**
+	 * @var CollectionInterface | FileSubmissionInterface[]
+	 */
+	protected $file_objects;
 
-    /**
-     * @var bool
-     */
-    protected $initialized = false;
+	/**
+	 * @var bool
+	 */
+	protected $initialized = false;
 
-    /**
-     * FilesDataHandler constructor.
-     * @param Request $request
-     */
-    public function __construct(Request $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * FilesDataHandler constructor.
+	 * @param Request $request
+	 */
+	public function __construct(Request $request)
+	{
+		$this->request = $request;
+	}
 
-    /**
-     * @since $VID:$
-     * @return CollectionInterface | FileSubmissionInterface[]
-     * @throws UnexpectedValueException
-     * @throws InvalidArgumentException
-     */
-    protected function getFileObjects()
-    {
-        $this->initialize();
-        return $this->file_objects;
-    }
+	/**
+	 * @since $VID:$
+	 * @return CollectionInterface | FileSubmissionInterface[]
+	 * @throws UnexpectedValueException
+	 * @throws InvalidArgumentException
+	 */
+	protected function getFileObjects()
+	{
+		$this->initialize();
+		return $this->file_objects;
+	}
 
-    /**
-     * Sets up the file objects from the request's $_FILES data.
-     * @since $VID:$
-     * @throws UnexpectedValueException
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function initialize()
-    {
-        if ($this->initialized) {
-            return;
-        }
-        $this->file_objects = new Collection(
-            // collection interface
-            'EventEspresso\core\services\request\files\FileSubmissionInterface',
-            // collection name
-            'submitted_files'
-        );
-        $files_raw_data = $this->request->filesParams();
-        if (empty($files_raw_data)) {
-            return;
-        }
-        if ($this->isStrangeFilesArray($files_raw_data)) {
-            $data = $this->fixFilesDataArray($files_raw_data);
-        } else {
-            $data = $files_raw_data;
-        }
-        $this->createFileObjects($data);
-        $this->initialized = true;
-    }
+	/**
+	 * Sets up the file objects from the request's $_FILES data.
+	 * @since $VID:$
+	 * @throws UnexpectedValueException
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function initialize()
+	{
+		if ($this->initialized) {
+			return;
+		}
+		$this->file_objects = new Collection(
+			// collection interface
+			'EventEspresso\core\services\request\files\FileSubmissionInterface',
+			// collection name
+			'submitted_files'
+		);
+		$files_raw_data = $this->request->filesParams();
+		if (empty($files_raw_data)) {
+			return;
+		}
+		if ($this->isStrangeFilesArray($files_raw_data)) {
+			$data = $this->fixFilesDataArray($files_raw_data);
+		} else {
+			$data = $files_raw_data;
+		}
+		$this->createFileObjects($data);
+		$this->initialized = true;
+	}
 
-    /**
-     * Detects if $_FILES is a weird multi-dimensional array that needs fixing or not.
-     * @since $VID:$
-     * @param $files_data
-     * @return bool
-     * @throws UnexpectedValueException
-     */
-    protected function isStrangeFilesArray($files_data)
-    {
-        if (!is_array($files_data)) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
-                        'event_espresso'
-                    ),
-                    (string) $files_data
-                )
-            );
-        }
-        $first_value = reset($files_data);
-        if (!is_array($first_value)) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
-                        'event_espresso'
-                    ),
-                    (string) $first_value
-                )
-            );
-        }
-        $first_sub_array_item = reset($first_value);
-        if (is_array($first_sub_array_item)) {
-            // not just a 2d array
-            return true;
-        }
-        // yep, just 2d array
-        return false;
-    }
+	/**
+	 * Detects if $_FILES is a weird multi-dimensional array that needs fixing or not.
+	 * @since $VID:$
+	 * @param $files_data
+	 * @return bool
+	 * @throws UnexpectedValueException
+	 */
+	protected function isStrangeFilesArray($files_data)
+	{
+		if (!is_array($files_data)) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
+						'event_espresso'
+					),
+					(string) $files_data
+				)
+			);
+		}
+		$first_value = reset($files_data);
+		if (!is_array($first_value)) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
+						'event_espresso'
+					),
+					(string) $first_value
+				)
+			);
+		}
+		$first_sub_array_item = reset($first_value);
+		if (is_array($first_sub_array_item)) {
+			// not just a 2d array
+			return true;
+		}
+		// yep, just 2d array
+		return false;
+	}
 
-    /**
-     * 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", "tmp_name", etc. So that file's data is located at "my[name][hierarchical][form]",
-     * "my[size][hierarchical][form]", "my[tmp_name][hierarchical][form]", etc. It's really weird.
-     * @since $VID:$
-     * @param $files_data
-     * @return array
-     */
-    protected function fixFilesDataArray($files_data)
-    {
-        $sane_files_array = [];
-        foreach ($files_data as $top_key => $top_key_value) {
-            foreach ($top_key_value as $lower_key => $lower_key_value) {
-                foreach ($lower_key_value as $lowest_key => $lowest_key_value) {
-                    $next_data = [
-                        $top_key => [
-                            $lowest_key => $this->organizeFilesData($lowest_key_value, $lower_key, $lowest_key)
-                        ]
-                    ];
-                    $sane_files_array = array_merge_recursive(
-                        $sane_files_array,
-                        $next_data
-                    );
-                }
-            }
-        }
-        return $sane_files_array;
-    }
+	/**
+	 * 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", "tmp_name", etc. So that file's data is located at "my[name][hierarchical][form]",
+	 * "my[size][hierarchical][form]", "my[tmp_name][hierarchical][form]", etc. It's really weird.
+	 * @since $VID:$
+	 * @param $files_data
+	 * @return array
+	 */
+	protected function fixFilesDataArray($files_data)
+	{
+		$sane_files_array = [];
+		foreach ($files_data as $top_key => $top_key_value) {
+			foreach ($top_key_value as $lower_key => $lower_key_value) {
+				foreach ($lower_key_value as $lowest_key => $lowest_key_value) {
+					$next_data = [
+						$top_key => [
+							$lowest_key => $this->organizeFilesData($lowest_key_value, $lower_key, $lowest_key)
+						]
+					];
+					$sane_files_array = array_merge_recursive(
+						$sane_files_array,
+						$next_data
+					);
+				}
+			}
+		}
+		return $sane_files_array;
+	}
 
-    /**
-     * Recursively explores the array until it finds a leaf node, and tacks `$type` as a final index in front of it.
-     * @since $VID:$
-     * @param $data either 'name', 'tmp_name', 'size', or 'error'
-     * @param $type
-     * @return array
-     */
-    protected function organizeFilesData($data, $type)
-    {
-        $organized_data = [];
-        foreach ($data as $key => $val) {
-            if (is_array($val)) {
-                $organized_data[ $key ] = $this->organizeFilesData($val, $type);
-            } else {
-                $organized_data[ $key ][ $type ] = $val;
-            }
-        }
-        return $organized_data;
-    }
+	/**
+	 * Recursively explores the array until it finds a leaf node, and tacks `$type` as a final index in front of it.
+	 * @since $VID:$
+	 * @param $data either 'name', 'tmp_name', 'size', or 'error'
+	 * @param $type
+	 * @return array
+	 */
+	protected function organizeFilesData($data, $type)
+	{
+		$organized_data = [];
+		foreach ($data as $key => $val) {
+			if (is_array($val)) {
+				$organized_data[ $key ] = $this->organizeFilesData($val, $type);
+			} else {
+				$organized_data[ $key ][ $type ] = $val;
+			}
+		}
+		return $organized_data;
+	}
 
-    /**
-     * Takes the organized $_FILES array (where all file info is located at the same spot as you'd expect an input
-     * to be in $_GET or $_POST, with all the file's data located side-by-side in an array) and creates a
-     * multi-dimensional array of FileSubmissionInterface objects. Stores it in `$this->file_objects`.
-     * @since $VID:$
-     * @param array $organized_files $_FILES but organized like $_POST
-     * @param array $name_parts_so_far for multidimensional HTML form names,
-     * @throws UnexpectedValueException
-     * @throws InvalidArgumentException
-     */
-    protected function createFileObjects($organized_files, $name_parts_so_far = [])
-    {
-        if (!is_array($organized_files)) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Unexpected PHP $organized_files data format. "%1$s" was expected to be an array.',
-                        'event_espresso'
-                    ),
-                    (string) $organized_files
-                )
-            );
-        }
-        foreach ($organized_files as $key => $value) {
-            array_push(
-                $name_parts_so_far,
-                $key
-            );
-            if (isset($value['name'], $value['tmp_name'], $value['size'])) {
-                $html_name = $this->inputNameFromParts($name_parts_so_far);
-                $this->file_objects->add(
-                    new FileSubmission(
-                        $html_name,
-                        $value['name'],
-                        $value['tmp_name'],
-                        $value['size'],
-                        $value['error']
-                    ),
-                    $html_name
-                );
-            } else {
-                $this->createFileObjects($value, $name_parts_so_far);
-            }
-        }
-    }
+	/**
+	 * Takes the organized $_FILES array (where all file info is located at the same spot as you'd expect an input
+	 * to be in $_GET or $_POST, with all the file's data located side-by-side in an array) and creates a
+	 * multi-dimensional array of FileSubmissionInterface objects. Stores it in `$this->file_objects`.
+	 * @since $VID:$
+	 * @param array $organized_files $_FILES but organized like $_POST
+	 * @param array $name_parts_so_far for multidimensional HTML form names,
+	 * @throws UnexpectedValueException
+	 * @throws InvalidArgumentException
+	 */
+	protected function createFileObjects($organized_files, $name_parts_so_far = [])
+	{
+		if (!is_array($organized_files)) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Unexpected PHP $organized_files data format. "%1$s" was expected to be an array.',
+						'event_espresso'
+					),
+					(string) $organized_files
+				)
+			);
+		}
+		foreach ($organized_files as $key => $value) {
+			array_push(
+				$name_parts_so_far,
+				$key
+			);
+			if (isset($value['name'], $value['tmp_name'], $value['size'])) {
+				$html_name = $this->inputNameFromParts($name_parts_so_far);
+				$this->file_objects->add(
+					new FileSubmission(
+						$html_name,
+						$value['name'],
+						$value['tmp_name'],
+						$value['size'],
+						$value['error']
+					),
+					$html_name
+				);
+			} else {
+				$this->createFileObjects($value, $name_parts_so_far);
+			}
+		}
+	}
 
-    /**
-     * Takes the input name parts, like `['my', 'great', 'file', 'input1']`
-     * and returns the HTML name for it, "my[great][file][input1]"
-     * @since $VID:$
-     * @param $parts
-     * @throws UnexpectedValueException
-     */
-    protected function inputNameFromParts($parts)
-    {
-        if (!is_array($parts)) {
-            throw new UnexpectedValueException(esc_html__('Name parts should be an array.', 'event_espresso'));
-        }
-        $generated_string = '';
-        foreach ($parts as $part) {
-            if ($generated_string === '') {
-                $generated_string = (string) $part;
-            } else {
-                $generated_string .= '[' . (string) $part . ']';
-            }
-        }
-        return $generated_string;
-    }
+	/**
+	 * Takes the input name parts, like `['my', 'great', 'file', 'input1']`
+	 * and returns the HTML name for it, "my[great][file][input1]"
+	 * @since $VID:$
+	 * @param $parts
+	 * @throws UnexpectedValueException
+	 */
+	protected function inputNameFromParts($parts)
+	{
+		if (!is_array($parts)) {
+			throw new UnexpectedValueException(esc_html__('Name parts should be an array.', 'event_espresso'));
+		}
+		$generated_string = '';
+		foreach ($parts as $part) {
+			if ($generated_string === '') {
+				$generated_string = (string) $part;
+			} else {
+				$generated_string .= '[' . (string) $part . ']';
+			}
+		}
+		return $generated_string;
+	}
 
-    /**
-     * Gets the input by the indicated $name_parts.
-     * Eg if you're looking for an input named "my[great][file][input1]", $name_parts
-     * should be `['my', 'great', 'file', 'input1']`.
-     * Alternatively, you could use `FileDataHandler::getFileObject('my[great][file][input1]');`
-     * @since $VID:$
-     * @param $name_parts
-     * @throws UnexpectedValueException
-     * @return FileSubmissionInterface
-     */
-    public function getFileObjectFromNameParts($name_parts)
-    {
-        return $this->getFileObjects()->get($this->inputNameFromParts($name_parts));
-    }
+	/**
+	 * Gets the input by the indicated $name_parts.
+	 * Eg if you're looking for an input named "my[great][file][input1]", $name_parts
+	 * should be `['my', 'great', 'file', 'input1']`.
+	 * Alternatively, you could use `FileDataHandler::getFileObject('my[great][file][input1]');`
+	 * @since $VID:$
+	 * @param $name_parts
+	 * @throws UnexpectedValueException
+	 * @return FileSubmissionInterface
+	 */
+	public function getFileObjectFromNameParts($name_parts)
+	{
+		return $this->getFileObjects()->get($this->inputNameFromParts($name_parts));
+	}
 
-    /**
-     * Gets the FileSubmissionInterface corresponding to the HTML name provided.
-     * @since $VID:$
-     * @param $html_name
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws UnexpectedValueException
-     */
-    public function getFileObject($html_name)
-    {
-        return $this->getFileObjects()->get($html_name);
-    }
+	/**
+	 * Gets the FileSubmissionInterface corresponding to the HTML name provided.
+	 * @since $VID:$
+	 * @param $html_name
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws UnexpectedValueException
+	 */
+	public function getFileObject($html_name)
+	{
+		return $this->getFileObjects()->get($html_name);
+	}
 }
 // End of file FilesDataHandler.php
 // Location: EventEspresso\core\services\request\files/FilesDataHandler.php

Spacing +7 added lines, -7 removed lines

@@ -114,7 +114,7 @@ 
      */
     protected function isStrangeFilesArray($files_data)
     {
-        if (!is_array($files_data)) {
+        if ( ! is_array($files_data)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -126,7 +126,7 @@ 
             );
         }
         $first_value = reset($files_data);
-        if (!is_array($first_value)) {
+        if ( ! is_array($first_value)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -188,9 +188,9 @@ 
         $organized_data = [];
         foreach ($data as $key => $val) {
             if (is_array($val)) {
-                $organized_data[ $key ] = $this->organizeFilesData($val, $type);
+                $organized_data[$key] = $this->organizeFilesData($val, $type);
             } else {
-                $organized_data[ $key ][ $type ] = $val;
+                $organized_data[$key][$type] = $val;
             }
         }
         return $organized_data;
@@ -208,7 +208,7 @@ 
      */
     protected function createFileObjects($organized_files, $name_parts_so_far = [])
     {
-        if (!is_array($organized_files)) {
+        if ( ! is_array($organized_files)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -251,7 +251,7 @@ 
      */
     protected function inputNameFromParts($parts)
     {
-        if (!is_array($parts)) {
+        if ( ! is_array($parts)) {
             throw new UnexpectedValueException(esc_html__('Name parts should be an array.', 'event_espresso'));
         }
         $generated_string = '';
@@ -259,7 +259,7 @@ 
             if ($generated_string === '') {
                 $generated_string = (string) $part;
             } else {
-                $generated_string .= '[' . (string) $part . ']';
+                $generated_string .= '['.(string) $part.']';
             }
         }
         return $generated_string;

core/entities/forms/UploadedFile.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
      * Makes sure the input has the desired key and casts it as the appropriate type.
      * @since $VID:$
      * @param $php_file_info_array
-     * @param $desired_key
+     * @param string $desired_key
      * @param string $cast_as "string" or "int"
      * @return int|string
      * @throws InvalidArgumentException

Indentation +103 added lines, -103 removed lines

@@ -17,121 +17,121 @@
  */
 class UploadedFile
 {
-    /**
-     * @var string original name on the client machine
-     */
-    protected $name;
+	/**
+	 * @var string original name on the client machine
+	 */
+	protected $name;
 
-    /**
-     * @var string mime type
-     */
-    protected $type;
+	/**
+	 * @var string mime type
+	 */
+	protected $type;
 
-    /**
-     * @var int in bytes
-     */
-    protected $size;
+	/**
+	 * @var int in bytes
+	 */
+	protected $size;
 
-    /**
-     * @var string local filepath to the temporary file
-     */
-    protected $tmp_name;
+	/**
+	 * @var string local filepath to the temporary file
+	 */
+	protected $tmp_name;
 
-    /**
-     * @var string one of https://secure.php.net/manual/en/features.file-upload.errors.php
-     */
-    protected $error;
+	/**
+	 * @var string one of https://secure.php.net/manual/en/features.file-upload.errors.php
+	 */
+	protected $error;
 
-    public function __construct($php_file_info)
-    {
-        $this->name = $this->extractFromArrayOrThrowException($php_file_info, 'name');
-        try {
-            $this->type = $this->extractFromArrayOrThrowException($php_file_info, 'type');
-        } catch (InvalidArgumentException $e) {
-            // The browser must have not provided the mimetype, oh well.
-            $this->type = 'text/html';
-        }
-        $this->size = $this->extractFromArrayOrThrowException($php_file_info, 'size', 'int');
-        $this->tmp_name = $this->extractFromArrayOrThrowException($php_file_info, 'tmp_name');
-    }
+	public function __construct($php_file_info)
+	{
+		$this->name = $this->extractFromArrayOrThrowException($php_file_info, 'name');
+		try {
+			$this->type = $this->extractFromArrayOrThrowException($php_file_info, 'type');
+		} catch (InvalidArgumentException $e) {
+			// The browser must have not provided the mimetype, oh well.
+			$this->type = 'text/html';
+		}
+		$this->size = $this->extractFromArrayOrThrowException($php_file_info, 'size', 'int');
+		$this->tmp_name = $this->extractFromArrayOrThrowException($php_file_info, 'tmp_name');
+	}
 
-    /**
-     * Makes sure the input has the desired key and casts it as the appropriate type.
-     * @since $VID:$
-     * @param $php_file_info_array
-     * @param $desired_key
-     * @param string $cast_as "string" or "int"
-     * @return int|string
-     * @throws InvalidArgumentException
-     */
-    protected function extractFromArrayOrThrowException($php_file_info_array, $desired_key, $cast_as = 'string')
-    {
-        if (!isset($php_file_info_array[$desired_key])) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('PHP Upload data for a file was missing the key %1$s', 'event_espresso'),
-                    $desired_key
-                )
-            );
-        }
-        $raw_value = $php_file_info_array[$desired_key];
-        switch ($cast_as) {
-            case 'int':
-                return (int)$raw_value;
-            case 'string':
-            default:
-                return (string)$raw_value;
-        }
-    }
+	/**
+	 * Makes sure the input has the desired key and casts it as the appropriate type.
+	 * @since $VID:$
+	 * @param $php_file_info_array
+	 * @param $desired_key
+	 * @param string $cast_as "string" or "int"
+	 * @return int|string
+	 * @throws InvalidArgumentException
+	 */
+	protected function extractFromArrayOrThrowException($php_file_info_array, $desired_key, $cast_as = 'string')
+	{
+		if (!isset($php_file_info_array[$desired_key])) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('PHP Upload data for a file was missing the key %1$s', 'event_espresso'),
+					$desired_key
+				)
+			);
+		}
+		$raw_value = $php_file_info_array[$desired_key];
+		switch ($cast_as) {
+			case 'int':
+				return (int)$raw_value;
+			case 'string':
+			default:
+				return (string)$raw_value;
+		}
+	}
 
-    /**
-     * @return string
-     */
-    public function getName()
-    {
-        return $this->name;
-    }
+	/**
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->name;
+	}
 
-    /**
-     * @return string
-     */
-    public function getType()
-    {
-        return $this->type;
-    }
+	/**
+	 * @return string
+	 */
+	public function getType()
+	{
+		return $this->type;
+	}
 
-    /**
-     * @return int
-     */
-    public function getSize()
-    {
-        return $this->size;
-    }
+	/**
+	 * @return int
+	 */
+	public function getSize()
+	{
+		return $this->size;
+	}
 
-    /**
-     * @return string
-     */
-    public function getTmpName()
-    {
-        return $this->tmp_name;
-    }
+	/**
+	 * @return string
+	 */
+	public function getTmpName()
+	{
+		return $this->tmp_name;
+	}
 
-    /**
-     * @return string
-     */
-    public function getError()
-    {
-        return $this->error;
-    }
+	/**
+	 * @return string
+	 */
+	public function getError()
+	{
+		return $this->error;
+	}
 
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->getTmpName();
-    }
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->getTmpName();
+	}
 }
 // End of file UploadedFile.php
 // Location: EventEspresso\core\entities\forms/UploadedFile.php

Spacing +3 added lines, -3 removed lines

@@ -66,7 +66,7 @@ 
      */
     protected function extractFromArrayOrThrowException($php_file_info_array, $desired_key, $cast_as = 'string')
     {
-        if (!isset($php_file_info_array[$desired_key])) {
+        if ( ! isset($php_file_info_array[$desired_key])) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('PHP Upload data for a file was missing the key %1$s', 'event_espresso'),
@@ -77,10 +77,10 @@ 
         $raw_value = $php_file_info_array[$desired_key];
         switch ($cast_as) {
             case 'int':
-                return (int)$raw_value;
+                return (int) $raw_value;
             case 'string':
             default:
-                return (string)$raw_value;
+                return (string) $raw_value;
         }
     }
 

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

Indentation +125 added lines, -125 removed lines

@@ -15,59 +15,59 @@ 
  */
 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(
-                ',',
+		$this->set_other_html_attributes(
+			$this->other_html_attributes()
+			. ' extension="'
+			. implode(
+				',',
 //                array_merge(
 //                    array_map(
 //                        function ($mime_type) {
@@ -80,86 +80,86 @@ 
 //                        },
 //                        $this->allowed_mime_types
 //                    )
-                    array_map(
-                        function ($file_extension) {
-                            return  $file_extension;
-                        },
-                        $this->allowed_file_extensions
-                    )
+					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)
-    {
-        $name_parts = $this->getInputNameParts();
-        // now get the value for the input
-        $value = $this->findFileData($name_parts, $req_data);
+	/**
+	 * 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)
+	{
+		$name_parts = $this->getInputNameParts();
+		// now get the value for the input
+		$value = $this->findFileData($name_parts, $req_data);
 
-        if (empty($value)) {
-            $value = $this->findFileData($name_parts, $_FILES);
-        }
-        if (empty($value)) {
-            array_shift($name_parts);
-            // check if this thing's name is at the TOP level of the request data
-            $value = $this->findFileData($name_parts, $req_data);
-        }
-        return $value;
-    }
+		if (empty($value)) {
+			$value = $this->findFileData($name_parts, $_FILES);
+		}
+		if (empty($value)) {
+			array_shift($name_parts);
+			// check if this thing's name is at the TOP level of the request data
+			$value = $this->findFileData($name_parts, $req_data);
+		}
+		return $value;
+	}
 
-    /**
-     * Look for the file's data in this request data.
-     * @since $VID:$
-     * @param $name_parts
-     * @param $req_data
-     * @return array
-     */
-    protected function findFileData($name_parts, $req_data)
-    {
-        $file_parts = [
-            'name',
-            'error',
-            'size',
-            'tmp_name',
-            'type'
-        ];
-        $file_data = [];
-        foreach($file_parts as $file_part){
-            $datum = $this->findRequestForSectionUsingNameParts($this->getFileDataNameParts($name_parts, $file_part),$req_data);
-            if(!empty($datum)) {
-                $file_data[$file_part] = $datum;
-            }
-        }
-        return $file_data;
-    }
+	/**
+	 * Look for the file's data in this request data.
+	 * @since $VID:$
+	 * @param $name_parts
+	 * @param $req_data
+	 * @return array
+	 */
+	protected function findFileData($name_parts, $req_data)
+	{
+		$file_parts = [
+			'name',
+			'error',
+			'size',
+			'tmp_name',
+			'type'
+		];
+		$file_data = [];
+		foreach($file_parts as $file_part){
+			$datum = $this->findRequestForSectionUsingNameParts($this->getFileDataNameParts($name_parts, $file_part),$req_data);
+			if(!empty($datum)) {
+				$file_data[$file_part] = $datum;
+			}
+		}
+		return $file_data;
+	}
 
-    /**
-     * Finds the file name parts for the desired file data.
-     * @since $VID:$
-     * @param $original_name_parts
-     * @param $file_data_sought
-     * @return array
-     */
-    protected function getFileDataNameParts($original_name_parts, $file_data_sought){
-        return
-            array_merge(
-                [
-                    $original_name_parts[0],
-                    $file_data_sought
-                ],
-            array_slice($original_name_parts, 1)
-        );
-    }
+	/**
+	 * Finds the file name parts for the desired file data.
+	 * @since $VID:$
+	 * @param $original_name_parts
+	 * @param $file_data_sought
+	 * @return array
+	 */
+	protected function getFileDataNameParts($original_name_parts, $file_data_sought){
+		return
+			array_merge(
+				[
+					$original_name_parts[0],
+					$file_data_sought
+				],
+			array_slice($original_name_parts, 1)
+		);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -32,7 +32,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'];
@@ -40,7 +40,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'];
@@ -57,7 +57,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);
@@ -81,7 +81,7 @@ 
 //                        $this->allowed_mime_types
 //                    )
                     array_map(
-                        function ($file_extension) {
+                        function($file_extension) {
                             return  $file_extension;
                         },
                         $this->allowed_file_extensions
@@ -136,9 +136,9 @@ 
             'type'
         ];
         $file_data = [];
-        foreach($file_parts as $file_part){
-            $datum = $this->findRequestForSectionUsingNameParts($this->getFileDataNameParts($name_parts, $file_part),$req_data);
-            if(!empty($datum)) {
+        foreach ($file_parts as $file_part) {
+            $datum = $this->findRequestForSectionUsingNameParts($this->getFileDataNameParts($name_parts, $file_part), $req_data);
+            if ( ! empty($datum)) {
                 $file_data[$file_part] = $datum;
             }
         }
@@ -152,7 +152,7 @@ 
      * @param $file_data_sought
      * @return array
      */
-    protected function getFileDataNameParts($original_name_parts, $file_data_sought){
+    protected function getFileDataNameParts($original_name_parts, $file_data_sought) {
         return
             array_merge(
                 [

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
+		);
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -171,7 +171,7 @@ 
      */
     public function form($for_display = false)
     {
-        if (! $this->formIsValid()) {
+        if ( ! $this->formIsValid()) {
             return null;
         }
         if ($for_display) {
@@ -273,7 +273,7 @@ 
      */
     public function setFormName($form_name)
     {
-        if (! is_string($form_name)) {
+        if ( ! is_string($form_name)) {
             throw new InvalidDataTypeException('$form_name', $form_name, 'string');
         }
         $this->form_name = $form_name;
@@ -297,7 +297,7 @@ 
      */
     public function setAdminName($admin_name)
     {
-        if (! is_string($admin_name)) {
+        if ( ! is_string($admin_name)) {
             throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
         }
         $this->admin_name = $admin_name;
@@ -321,7 +321,7 @@ 
      */
     public function setSlug($slug)
     {
-        if (! is_string($slug)) {
+        if ( ! is_string($slug)) {
             throw new InvalidDataTypeException('$slug', $slug, 'string');
         }
         $this->slug = $slug;
@@ -344,7 +344,7 @@ 
      */
     public function setSubmitBtnText($submit_btn_text)
     {
-        if (! is_string($submit_btn_text)) {
+        if ( ! is_string($submit_btn_text)) {
             throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
         }
         if (empty($submit_btn_text)) {
@@ -373,7 +373,7 @@ 
      */
     public function setFormAction($form_action)
     {
-        if (! is_string($form_action)) {
+        if ( ! is_string($form_action)) {
             throw new InvalidDataTypeException('$form_action', $form_action, 'string');
         }
         $this->form_action = $form_action;
@@ -418,7 +418,7 @@ 
      */
     public function setFormConfig($form_config)
     {
-        if (! in_array(
+        if ( ! in_array(
             $form_config,
             array(
                 FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
@@ -491,11 +491,11 @@ 
         $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_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() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => $text,
             )
         );
@@ -511,11 +511,11 @@ 
      */
     public function appendSubmitButton($text = '')
     {
-        if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
+        if ($this->form->subsection_exists($this->slug().'-submit-btn')) {
             return;
         }
         $this->form->add_subsections(
-            array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
+            array($this->slug().'-submit-btn' => $this->generateSubmitButton($text)),
             null,
             false
         );
@@ -532,11 +532,11 @@ 
     {
         $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_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() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
             )
         );
@@ -556,7 +556,7 @@ 
         $this->form->add_subsections(
             array(
                 'clear-submit-btn-float' => new EE_Form_Section_HTML(
-                    EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
+                    EEH_HTML::div('', '', 'clear-float').EEH_HTML::divx()
                 ),
             ),
             null,
@@ -586,7 +586,7 @@ 
         if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
             || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
         ) {
-            if($this->requiresMultipartEnctype()){
+            if ($this->requiresMultipartEnctype()) {
                 $additional_props = 'enctype="multipart/form-data"';
             } else {
                 $additional_props = '';
@@ -618,8 +618,8 @@ 
      */
     public function requiresMultipartEnctype()
     {
-        foreach($this->form()->inputs_in_subsections() as $input){
-            if($input instanceof EE_File_Input){
+        foreach ($this->form()->inputs_in_subsections() as $input) {
+            if ($input instanceof EE_File_Input) {
                 return true;
             }
         }
@@ -642,11 +642,11 @@ 
      */
     public function process($submitted_form_data = array())
     {
-        if (! $this->form()->was_submitted($submitted_form_data)) {
+        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()) {
+        if ( ! $this->form()->is_valid()) {
             throw new InvalidFormSubmissionException(
                 $this->form_name,
                 sprintf(

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

Indentation +35 added lines, -35 removed lines

@@ -13,41 +13,41 @@
 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 UploadedFile
-     */
-    public function normalize($value_to_normalize)
-    {
-        if (is_array($value_to_normalize)) {
-            return new UploadedFile($value_to_normalize);
-        } elseif( $value_to_normalize instanceof UploadedFile){
-            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 UploadedFile
+	 */
+	public function normalize($value_to_normalize)
+	{
+		if (is_array($value_to_normalize)) {
+			return new UploadedFile($value_to_normalize);
+		} elseif( $value_to_normalize instanceof UploadedFile){
+			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 UploadedFile) {
-            // Leave it as the object, it can be treated like a string because it
-            // overrides __toString()
-            return $normalized_value;
-        } elseif (is_array($normalized_value)) {
-            return new UploadedFile($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 UploadedFile) {
+			// Leave it as the object, it can be treated like a string because it
+			// overrides __toString()
+			return $normalized_value;
+		} elseif (is_array($normalized_value)) {
+			return new UploadedFile($normalized_value);
+		} else {
+			return (string) $normalized_value;
+		}
+	}
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
     {
         if (is_array($value_to_normalize)) {
             return new UploadedFile($value_to_normalize);
-        } elseif( $value_to_normalize instanceof UploadedFile){
+        } elseif ($value_to_normalize instanceof UploadedFile) {
             return $value_to_normalize;
         } else {
             throw new EE_Validation_Error(

core/libraries/form_sections/strategies/display/EE_File_Input_Display_Strategy.strategy.php

Indentation +13 added lines, -13 removed lines

@@ -10,20 +10,20 @@
  */
 class EE_File_Input_Display_Strategy extends EE_Text_Input_Display_Strategy
 {
-    /**
-     * The html "type" attribute value. default is "text"
-     * @var string
-     */
-    protected $allowed_extensions;
+	/**
+	 * The html "type" attribute value. default is "text"
+	 * @var string
+	 */
+	protected $allowed_extensions;
 
 
 
-    /**
-     * @param string $allowed_extensions
-     */
-    public function __construct($type = 'file', $allowed_extensions = [])
-    {
-        $this->allowed_extensions = $allowed_extensions;
-        parent::__construct($type);
-    }
+	/**
+	 * @param string $allowed_extensions
+	 */
+	public function __construct($type = 'file', $allowed_extensions = [])
+	{
+		$this->allowed_extensions = $allowed_extensions;
+		parent::__construct($type);
+	}
 }

core/libraries/form_sections/strategies/display/EE_Text_Input_Display_Strategy.strategy.php

Indentation +45 added lines, -45 removed lines

@@ -13,58 +13,58 @@
  */
 class EE_Text_Input_Display_Strategy extends EE_Display_Strategy_Base
 {
-    /**
-     * The html "type" attribute value. default is "text"
-     * @var string
-     */
-    protected $_type;
+	/**
+	 * The html "type" attribute value. default is "text"
+	 * @var string
+	 */
+	protected $_type;
 
 
 
-    /**
-     * @param string $allowed_extensions
-     */
-    public function __construct($allowed_extensions = 'text')
-    {
-        $this->_type = $allowed_extensions;
-        parent::__construct();
-    }
+	/**
+	 * @param string $allowed_extensions
+	 */
+	public function __construct($allowed_extensions = 'text')
+	{
+		$this->_type = $allowed_extensions;
+		parent::__construct();
+	}
 
 
 
-    /**
-     * Gets the html "type" attribute's value
-     * @return string
-     */
-    public function get_type()
-    {
-        if ($this->_type === 'email'
-            && ! apply_filters('FHEE__EE_Text_Input_Display_Strategy__use_html5_email', false)
-        ) {
-            return 'text';
-        }
-        return $this->_type;
-    }
+	/**
+	 * Gets the html "type" attribute's value
+	 * @return string
+	 */
+	public function get_type()
+	{
+		if ($this->_type === 'email'
+			&& ! apply_filters('FHEE__EE_Text_Input_Display_Strategy__use_html5_email', false)
+		) {
+			return 'text';
+		}
+		return $this->_type;
+	}
 
 
 
-    /**
-     *
-     * @return string of html to display the field
-     */
-    public function display()
-    {
-        $input = '<input type="'. $this->get_type() .'"';
-        $input .= ' name="' . $this->_input->html_name() . '"';
-        $input .= ' id="' . $this->_input->html_id() . '"';
-        $class = $this->_input->required() ? $this->_input->required_css_class() . ' ' . $this->_input->html_class() : $this->_input->html_class();
-        $input .= ' class="' . $class . '"';
-        // add html5 required
-        $input .= $this->_input->required() ? ' required' : '';
-        $input .= ' value="' . $this->_input->raw_value_in_form() . '"';
-        $input .= ' style="' . $this->_input->html_style() . '"';
-        $input .= $this->_input->other_html_attributes();
-        $input .= '/>';
-        return $input;
-    }
+	/**
+	 *
+	 * @return string of html to display the field
+	 */
+	public function display()
+	{
+		$input = '<input type="'. $this->get_type() .'"';
+		$input .= ' name="' . $this->_input->html_name() . '"';
+		$input .= ' id="' . $this->_input->html_id() . '"';
+		$class = $this->_input->required() ? $this->_input->required_css_class() . ' ' . $this->_input->html_class() : $this->_input->html_class();
+		$input .= ' class="' . $class . '"';
+		// add html5 required
+		$input .= $this->_input->required() ? ' required' : '';
+		$input .= ' value="' . $this->_input->raw_value_in_form() . '"';
+		$input .= ' style="' . $this->_input->html_style() . '"';
+		$input .= $this->_input->other_html_attributes();
+		$input .= '/>';
+		return $input;
+	}
 }