eventespresso / event-espresso-core

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;