eventespresso / event-espresso-core

core/services/request/files/FileSubmission.php

Indentation +133 added lines, -133 removed lines

@@ -18,139 +18,139 @@
  */
 class FileSubmission implements FileSubmissionInterface
 {
-    /**
-     * @var string original name on the client machine
-     */
-    protected $name;
-
-    /**
-     * @var string mime type
-     */
-    protected $type;
-
-    /**
-     * @var string file extension
-     */
-    protected $extension;
-
-    /**
-     * @var int in bytes
-     */
-    protected $size;
-
-    /**
-     * @var string local filepath to the temporary file
-     */
-    protected $tmp_file;
-
-    /**
-     * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values
-     * although those aren't expected.
-     */
-    protected $error_code;
-
-    public function __construct($name, $tmp_file, $size, $error_code = null)
-    {
-        $this->name = basename($name);
-        $this->tmp_file = $tmp_file;
-        $this->size = (int) $size;
-        $this->error_code = (int) $error_code;
-    }
-
-    /**
-     * @return string
-     */
-    public function getName()
-    {
-        return $this->name;
-    }
-
-    /**
-     * Gets the file's mime type
-     * @return string
-     */
-    public function getType()
-    {
-        if (!$this->type) {
-            $this->type = $this->determineType();
-        }
-        return $this->type;
-    }
-
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    protected function determineType()
-    {
-        if (!$this->getTmpFile()) {
-            return '';
-        }
-        $finfo = new finfo(FILEINFO_MIME_TYPE);
-        return $finfo->file($this->getTmpFile());
-    }
-
-    /**
-     * Gets the file's extension.
-     * @since $VID:$
-     * @return string
-     */
-    public function getExtension()
-    {
-        if (!$this->extension) {
-            $this->extension = $this->determineExtension();
-        }
-        return $this->extension;
-    }
-
-    /**
-     * Determine's the file's extension given the temporary file.
-     * @since $VID:$
-     * @return string
-     */
-    protected function determineExtension()
-    {
-        if (!$this->getTmpFile()) {
-            return '';
-        }
-        return pathinfo($this->getTmpFile(), PATHINFO_EXTENSION);
-    }
-
-    /**
-     * Gets the size of the file
-     * @return int
-     */
-    public function getSize()
-    {
-        return $this->size;
-    }
-
-    /**
-     * Gets the path to the temporary file which was uploaded.
-     * @return string
-     */
-    public function getTmpFile()
-    {
-        return $this->tmp_file;
-    }
-
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->getTmpFile();
-    }
-
-    /**
-     * Gets the error code PHP reported for the file upload.
-     * @return string
-     */
-    public function getErrorCode()
-    {
-        return $this->error_code;
-    }
+	/**
+	 * @var string original name on the client machine
+	 */
+	protected $name;
+
+	/**
+	 * @var string mime type
+	 */
+	protected $type;
+
+	/**
+	 * @var string file extension
+	 */
+	protected $extension;
+
+	/**
+	 * @var int in bytes
+	 */
+	protected $size;
+
+	/**
+	 * @var string local filepath to the temporary file
+	 */
+	protected $tmp_file;
+
+	/**
+	 * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values
+	 * although those aren't expected.
+	 */
+	protected $error_code;
+
+	public function __construct($name, $tmp_file, $size, $error_code = null)
+	{
+		$this->name = basename($name);
+		$this->tmp_file = $tmp_file;
+		$this->size = (int) $size;
+		$this->error_code = (int) $error_code;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->name;
+	}
+
+	/**
+	 * Gets the file's mime type
+	 * @return string
+	 */
+	public function getType()
+	{
+		if (!$this->type) {
+			$this->type = $this->determineType();
+		}
+		return $this->type;
+	}
+
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	protected function determineType()
+	{
+		if (!$this->getTmpFile()) {
+			return '';
+		}
+		$finfo = new finfo(FILEINFO_MIME_TYPE);
+		return $finfo->file($this->getTmpFile());
+	}
+
+	/**
+	 * Gets the file's extension.
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function getExtension()
+	{
+		if (!$this->extension) {
+			$this->extension = $this->determineExtension();
+		}
+		return $this->extension;
+	}
+
+	/**
+	 * Determine's the file's extension given the temporary file.
+	 * @since $VID:$
+	 * @return string
+	 */
+	protected function determineExtension()
+	{
+		if (!$this->getTmpFile()) {
+			return '';
+		}
+		return pathinfo($this->getTmpFile(), PATHINFO_EXTENSION);
+	}
+
+	/**
+	 * Gets the size of the file
+	 * @return int
+	 */
+	public function getSize()
+	{
+		return $this->size;
+	}
+
+	/**
+	 * Gets the path to the temporary file which was uploaded.
+	 * @return string
+	 */
+	public function getTmpFile()
+	{
+		return $this->tmp_file;
+	}
+
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->getTmpFile();
+	}
+
+	/**
+	 * Gets the error code PHP reported for the file upload.
+	 * @return string
+	 */
+	public function getErrorCode()
+	{
+		return $this->error_code;
+	}
 }
 // End of file FileSubmission.php
 // Location: EventEspresso\core\services\request\files/FileSubmission.php

Spacing +4 added lines, -4 removed lines

@@ -71,7 +71,7 @@ 
      */
     public function getType()
     {
-        if (!$this->type) {
+        if ( ! $this->type) {
             $this->type = $this->determineType();
         }
         return $this->type;
@@ -83,7 +83,7 @@ 
      */
     protected function determineType()
     {
-        if (!$this->getTmpFile()) {
+        if ( ! $this->getTmpFile()) {
             return '';
         }
         $finfo = new finfo(FILEINFO_MIME_TYPE);
@@ -97,7 +97,7 @@ 
      */
     public function getExtension()
     {
-        if (!$this->extension) {
+        if ( ! $this->extension) {
             $this->extension = $this->determineExtension();
         }
         return $this->extension;
@@ -110,7 +110,7 @@ 
      */
     protected function determineExtension()
     {
-        if (!$this->getTmpFile()) {
+        if ( ! $this->getTmpFile()) {
             return '';
         }
         return pathinfo($this->getTmpFile(), PATHINFO_EXTENSION);

core/services/request/files/FilesDataHandler.php

Indentation +179 added lines, -179 removed lines

@@ -42,194 +42,194 @@
  */
 class FilesDataHandler
 {
-    /**
-     * @var Request
-     */
-    protected $request;
+	/**
+	 * @var Request
+	 */
+	protected $request;
 
-    /**
-     * @var array
-     */
-    protected $file_objects;
+	/**
+	 * @var array
+	 */
+	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 array with a similar structure to $_POST and $_GET (ie, it can be multi-dimensional) but the "leaf"
-     * nodes are all of type FileSubmissionInterface
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @throws UnexpectedValueException
-     */
-    public function getFileObjects()
-    {
-        if (!$this->initialized) {
-            $this->initialize();
-        }
-        return $this->file_objects;
-    }
+	/**
+	 * @since $VID:$
+	 * @return array with a similar structure to $_POST and $_GET (ie, it can be multi-dimensional) but the "leaf"
+	 * nodes are all of type FileSubmissionInterface
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @throws UnexpectedValueException
+	 */
+	public function getFileObjects()
+	{
+		if (!$this->initialized) {
+			$this->initialize();
+		}
+		return $this->file_objects;
+	}
 
-    /**
-     * Sets up the file objects from the request's $_FILES data.
-     * @since $VID:$
-     * @throws UnexpectedValueException
-     */
-    protected function initialize()
-    {
-        $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->file_objects = $this->createFileObjects($data);
-        $this->initialized = true;
-    }
+	/**
+	 * Sets up the file objects from the request's $_FILES data.
+	 * @since $VID:$
+	 * @throws UnexpectedValueException
+	 */
+	protected function initialize()
+	{
+		$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->file_objects = $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_avlue) {
-            foreach ($top_key_avlue 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_avlue) {
+			foreach ($top_key_avlue 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.
-     * @since $VID:$
-     * @param $organized_files
-     * @return array
-     * @throws UnexpectedValueException
-     */
-    protected function createFileObjects($organized_files)
-    {
-        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
-                )
-            );
-        }
-        $objs = [];
-        foreach ($organized_files as $key => $value) {
-            if (isset($value['name'], $value['tmp_name'], $value['size'])) {
-                $objs[ $key ] = new FileSubmission(
-                    $value['name'],
-                    $value['tmp_name'],
-                    $value['size'],
-                    $value['error']
-                );
-            } else {
-                $objs[ $key ] = $this->createFileObjects($value);
-            }
-        }
-        return $objs;
-    }
+	/**
+	 * 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.
+	 * @since $VID:$
+	 * @param $organized_files
+	 * @return array
+	 * @throws UnexpectedValueException
+	 */
+	protected function createFileObjects($organized_files)
+	{
+		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
+				)
+			);
+		}
+		$objs = [];
+		foreach ($organized_files as $key => $value) {
+			if (isset($value['name'], $value['tmp_name'], $value['size'])) {
+				$objs[ $key ] = new FileSubmission(
+					$value['name'],
+					$value['tmp_name'],
+					$value['size'],
+					$value['error']
+				);
+			} else {
+				$objs[ $key ] = $this->createFileObjects($value);
+			}
+		}
+		return $objs;
+	}
 }
 // End of file FilesDataHandler.php
 // Location: EventEspresso\core\services\request\files/FilesDataHandler.php

Spacing +8 added lines, -8 removed lines

@@ -76,7 +76,7 @@ 
      */
     public function getFileObjects()
     {
-        if (!$this->initialized) {
+        if ( ! $this->initialized) {
             $this->initialize();
         }
         return $this->file_objects;
@@ -111,7 +111,7 @@ 
      */
     protected function isStrangeFilesArray($files_data)
     {
-        if (!is_array($files_data)) {
+        if ( ! is_array($files_data)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -123,7 +123,7 @@ 
             );
         }
         $first_value = reset($files_data);
-        if (!is_array($first_value)) {
+        if ( ! is_array($first_value)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -185,9 +185,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;
@@ -204,7 +204,7 @@ 
      */
     protected function createFileObjects($organized_files)
     {
-        if (!is_array($organized_files)) {
+        if ( ! is_array($organized_files)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -218,14 +218,14 @@ 
         $objs = [];
         foreach ($organized_files as $key => $value) {
             if (isset($value['name'], $value['tmp_name'], $value['size'])) {
-                $objs[ $key ] = new FileSubmission(
+                $objs[$key] = new FileSubmission(
                     $value['name'],
                     $value['tmp_name'],
                     $value['size'],
                     $value['error']
                 );
             } else {
-                $objs[ $key ] = $this->createFileObjects($value);
+                $objs[$key] = $this->createFileObjects($value);
             }
         }
         return $objs;