eventespresso / event-espresso-core

core/services/graphql/connections/ConnectionBase.php

Indentation +15 added lines, -15 removed lines

@@ -15,22 +15,22 @@
 abstract class ConnectionBase implements ConnectionInterface
 {
 
-    /**
-     * @var EEM_Base $model
-     */
-    protected $model;
+	/**
+	 * @var EEM_Base $model
+	 */
+	protected $model;
 
-    /**
-     * @var string $namespace The graphql namespace/prefix.
-     */
-    protected $namespace = 'Espresso';
+	/**
+	 * @var string $namespace The graphql namespace/prefix.
+	 */
+	protected $namespace = 'Espresso';
 
 
-    /**
-     * @param EEM_Base $model
-     */
-    public function __construct(EEM_Base $model)
-    {
-        $this->model = $model;
-    }
+	/**
+	 * @param EEM_Base $model
+	 */
+	public function __construct(EEM_Base $model)
+	{
+		$this->model = $model;
+	}
 }

core/services/graphql/loaders/GQLDataDomainInterface.php

Indentation +8 added lines, -8 removed lines

@@ -15,12 +15,12 @@
 interface GQLDataDomainInterface
 {
 
-    /**
-     * @param array      $loaders The loaders accessible in the AppContext
-     * @param AppContext $context The AppContext
-     * @return array
-     * @return array
-     * @since $VID:$
-     */
-    public function registerLoaders(array $loaders, AppContext $context): array;
+	/**
+	 * @param array      $loaders The loaders accessible in the AppContext
+	 * @param AppContext $context The AppContext
+	 * @return array
+	 * @return array
+	 * @since $VID:$
+	 */
+	public function registerLoaders(array $loaders, AppContext $context): array;
 }

core/services/graphql/types/TypeInterface.php

Indentation +75 added lines, -75 removed lines

@@ -24,79 +24,79 @@
 interface TypeInterface
 {
 
-    /**
-     * @return string
-     */
-    public function name(): string;
-
-
-    /**
-     * @return string
-     */
-    public function description(): string;
-
-
-    /**
-     * @return GraphQLFieldInterface[]
-     * @since $VID:$
-     */
-    public function fields(): array;
-
-
-    /**
-     * Creates a key map for internal resolver.
-     *
-     * @return array
-     * @since $VID:$
-     */
-    public function getFieldsForResolver(): array;
-
-
-    /**
-     * @return bool
-     */
-    public function isCustomPostType(): bool;
-
-
-    /**
-     * @param int|float $value
-     * @return int
-     * @since $VID:$
-     */
-    public function parseInfiniteValue($value): int;
-
-
-    /**
-     * @param mixed       $source  The source that's passed down the GraphQL queries
-     * @param array       $args    The inputArgs on the field
-     * @param AppContext  $context The AppContext passed down the GraphQL tree
-     * @param ResolveInfo $info    The ResolveInfo passed down the GraphQL tree
-     * @return mixed
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     * @throws UserError
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since $VID:$
-     */
-    public function resolveField($source, array $args, AppContext $context, ResolveInfo $info);
-
-
-    /**
-     * @param mixed      $payload The payload returned after mutation
-     * @param array      $args    The inputArgs on the field
-     * @param AppContext $context The AppContext passed down the GraphQL tree
-     * @return string|null
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     * @throws UserError
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since $VID:$
-     */
-    public function resolveFromPayload($payload, array $args, AppContext $context);
+	/**
+	 * @return string
+	 */
+	public function name(): string;
+
+
+	/**
+	 * @return string
+	 */
+	public function description(): string;
+
+
+	/**
+	 * @return GraphQLFieldInterface[]
+	 * @since $VID:$
+	 */
+	public function fields(): array;
+
+
+	/**
+	 * Creates a key map for internal resolver.
+	 *
+	 * @return array
+	 * @since $VID:$
+	 */
+	public function getFieldsForResolver(): array;
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCustomPostType(): bool;
+
+
+	/**
+	 * @param int|float $value
+	 * @return int
+	 * @since $VID:$
+	 */
+	public function parseInfiniteValue($value): int;
+
+
+	/**
+	 * @param mixed       $source  The source that's passed down the GraphQL queries
+	 * @param array       $args    The inputArgs on the field
+	 * @param AppContext  $context The AppContext passed down the GraphQL tree
+	 * @param ResolveInfo $info    The ResolveInfo passed down the GraphQL tree
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 * @throws UserError
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since $VID:$
+	 */
+	public function resolveField($source, array $args, AppContext $context, ResolveInfo $info);
+
+
+	/**
+	 * @param mixed      $payload The payload returned after mutation
+	 * @param array      $args    The inputArgs on the field
+	 * @param AppContext $context The AppContext passed down the GraphQL tree
+	 * @return string|null
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 * @throws UserError
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since $VID:$
+	 */
+	public function resolveFromPayload($payload, array $args, AppContext $context);
 }

core/services/json/JsonDataHandler.php

Indentation +333 added lines, -333 removed lines

@@ -14,337 +14,337 @@
  */
 class JsonDataHandler
 {
-    const DATA_TYPE_ARRAY     = 'array';
-
-    const DATA_TYPE_OBJECT    = 'object';
-
-    const DATA_TYPE_USE_FLAGS = 'flags';
-
-    const NO_ERROR_MSG        = 'No error';
-
-    /**
-     * @var string
-     */
-    private $data_type;
-
-    /**
-     * @var array|stdClass
-     */
-    private $decoded_data;
-
-    /**
-     * JSON_BIGINT_AS_STRING,
-     * JSON_INVALID_UTF8_IGNORE,
-     * JSON_INVALID_UTF8_SUBSTITUTE,
-     * JSON_OBJECT_AS_ARRAY,
-     * JSON_THROW_ON_ERROR
-     *
-     * @var int
-     */
-    private $decode_flags;
-
-    /**
-     * @var int
-     */
-    private $depth;
-
-    /**
-     * @var string
-     */
-    private $encoded_data;
-
-    /**
-     * JSON_FORCE_OBJECT,
-     * JSON_HEX_QUOT,
-     * JSON_HEX_TAG,
-     * JSON_HEX_AMP,
-     * JSON_HEX_APOS,
-     * JSON_INVALID_UTF8_IGNORE,
-     * JSON_INVALID_UTF8_SUBSTITUTE,
-     * JSON_NUMERIC_CHECK,
-     * JSON_PARTIAL_OUTPUT_ON_ERROR,
-     * JSON_PRESERVE_ZERO_FRACTION,
-     * JSON_PRETTY_PRINT,
-     * JSON_UNESCAPED_LINE_TERMINATORS,
-     * JSON_UNESCAPED_SLASHES,
-     * JSON_UNESCAPED_UNICODE,
-     * JSON_THROW_ON_ERROR.
-     *
-     * @var int
-     */
-    private $encode_flags;
-
-    /**
-     * @var int
-     */
-    private $last_error_code = JSON_ERROR_NONE;
-
-    /**
-     * @var string
-     */
-    private $last_error_msg = JsonDataHandler::NO_ERROR_MSG;
-
-
-    /**
-     * JsonDataHandler constructor.
-     */
-    public function __construct()
-    {
-        if (! defined('JSON_INVALID_UTF8_IGNORE')) {
-            define('JSON_INVALID_UTF8_IGNORE', 1048576);
-        }
-        if (! defined('JSON_INVALID_UTF8_SUBSTITUTE')) {
-            define('JSON_INVALID_UTF8_SUBSTITUTE', 2097152);
-        }
-        if (! defined('JSON_THROW_ON_ERROR')) {
-            define('JSON_THROW_ON_ERROR', 4194304);
-        }
-    }
-
-
-    /**
-     * set $data_type, $decode_flags, $encode_flags, and depth all in one shot
-     *
-     * @param string $data_type
-     * @param int    $decode_flags
-     * @param int    $encode_flags
-     * @param int    $depth
-     */
-    public function configure(
-        string $data_type = JsonDataHandler::DATA_TYPE_USE_FLAGS,
-        int $decode_flags = 0,
-        int $encode_flags = 0,
-        int $depth = 512
-    ) {
-        $this->setDataType($data_type);
-        $this->setDecodeFlags($decode_flags);
-        $this->setDepth($depth);
-        $this->setEncodeFlags($encode_flags);
-    }
-
-
-    /**
-     * @param string $data_type
-     */
-    public function setDataType(string $data_type): void
-    {
-        $this->data_type = $data_type === JsonDataHandler::DATA_TYPE_ARRAY
-                           || $data_type === JsonDataHandler::DATA_TYPE_OBJECT
-                           || $data_type === JsonDataHandler::DATA_TYPE_USE_FLAGS
-            ? $data_type
-            : JsonDataHandler::DATA_TYPE_USE_FLAGS;
-    }
-
-
-    /**
-     * One or more Bitmask values:
-     * JSON_BIGINT_AS_STRING,
-     * JSON_INVALID_UTF8_IGNORE,        PHP >= 7.2
-     * JSON_INVALID_UTF8_SUBSTITUTE,    PHP >= 7.2
-     * JSON_OBJECT_AS_ARRAY,
-     * JSON_THROW_ON_ERROR              PHP >= 7.3
-     *
-     * pass multiple values separated with |
-     * ex: JSON_BIGINT_AS_STRING | JSON_INVALID_UTF8_IGNORE | JSON_OBJECT_AS_ARRAY
-     *
-     * @param int $decode_flags
-     */
-    public function setDecodeFlags(int $decode_flags): void
-    {
-        $this->decode_flags = $decode_flags === JSON_BIGINT_AS_STRING
-                              || $decode_flags === JSON_OBJECT_AS_ARRAY
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_ignoreFound
-                              || $decode_flags === JSON_INVALID_UTF8_IGNORE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_substituteFound
-                              || $decode_flags === JSON_INVALID_UTF8_SUBSTITUTE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_throw_on_errorFound
-                              || $decode_flags === JSON_THROW_ON_ERROR
-            ? $decode_flags
-            : 0;
-    }
-
-
-    /**
-     * @param int $depth
-     */
-    public function setDepth(int $depth): void
-    {
-        $depth       = absint($depth);
-        $this->depth = $depth ?: 512;
-    }
-
-
-    /**
-     * One or more Bitmask values:
-     * JSON_FORCE_OBJECT,
-     * JSON_HEX_QUOT,
-     * JSON_HEX_TAG,
-     * JSON_HEX_AMP,
-     * JSON_HEX_APOS,
-     * JSON_INVALID_UTF8_IGNORE,        PHP >= 7.2
-     * JSON_INVALID_UTF8_SUBSTITUTE,    PHP >= 7.2
-     * JSON_NUMERIC_CHECK,
-     * JSON_PARTIAL_OUTPUT_ON_ERROR,
-     * JSON_PRESERVE_ZERO_FRACTION,
-     * JSON_PRETTY_PRINT,
-     * JSON_UNESCAPED_LINE_TERMINATORS,
-     * JSON_UNESCAPED_SLASHES,
-     * JSON_UNESCAPED_UNICODE,
-     * JSON_THROW_ON_ERROR.             PHP >= 7.3
-     *
-     * pass multiple values separated with |
-     * ex: JSON_FORCE_OBJECT | JSON_INVALID_UTF8_IGNORE | JSON_THROW_ON_ERROR
-     *
-     * @param int $encode_flags
-     */
-    public function setEncodeFlags(int $encode_flags): void
-    {
-        $this->encode_flags = $encode_flags === JSON_FORCE_OBJECT
-                              || $encode_flags === JSON_HEX_QUOT
-                              || $encode_flags === JSON_HEX_TAG
-                              || $encode_flags === JSON_HEX_AMP
-                              || $encode_flags === JSON_HEX_APOS
-                              || $encode_flags === JSON_NUMERIC_CHECK
-                              || $encode_flags === JSON_PARTIAL_OUTPUT_ON_ERROR
-                              || $encode_flags === JSON_PRESERVE_ZERO_FRACTION
-                              || $encode_flags === JSON_PRETTY_PRINT
-                              || $encode_flags === JSON_UNESCAPED_LINE_TERMINATORS
-                              || $encode_flags === JSON_UNESCAPED_SLASHES
-                              || $encode_flags === JSON_UNESCAPED_UNICODE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_ignoreFound
-                              || $encode_flags === JSON_INVALID_UTF8_IGNORE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_substituteFound
-                              || $encode_flags === JSON_INVALID_UTF8_SUBSTITUTE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_throw_on_errorFound
-                              || $encode_flags === JSON_THROW_ON_ERROR
-            ? $encode_flags
-            : 0;
-    }
-
-
-    /**
-     * @return bool|null
-     */
-    private function asAssociative(): ?bool
-    {
-        switch ($this->data_type) {
-            case JsonDataHandler::DATA_TYPE_ARRAY:
-                return true;
-            case JsonDataHandler::DATA_TYPE_OBJECT:
-                return false;
-            case JsonDataHandler::DATA_TYPE_USE_FLAGS:
-                return null;
-        }
-        return null;
-    }
-
-
-    /**
-     * @param array|string $json
-     * @return array|mixed|stdClass
-     */
-    public function decodeJson($json)
-    {
-        $this->resetErrors();
-        if ($this->isJson($json)) {
-            $this->decoded_data    = json_decode($json, $this->asAssociative(), $this->depth, $this->decode_flags);
-            $this->last_error_code = json_last_error();
-            $this->last_error_msg  = json_last_error_msg();
-        } else {
-            $this->decoded_data    = $json;
-            $this->last_error_code = JSON_ERROR_NONE;
-            $this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
-        }
-        return $this->decoded_data;
-    }
-
-
-    /**
-     * @param $data
-     * @return string
-     */
-    public function encodeData($data): string
-    {
-        $this->resetErrors();
-        if ($this->isJson($data)) {
-            $this->encoded_data = $data;
-            $this->last_error_code = JSON_ERROR_NONE;
-            $this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
-        } else {
-            $this->encoded_data = json_encode($data, $this->encode_flags, $this->depth);
-            $this->last_error_code = json_last_error();
-            $this->last_error_msg  = json_last_error_msg();
-        }
-        return $this->encoded_data ?: '{}';
-    }
-
-
-    /**
-     * @return array|stdClass
-     */
-    public function getDecodedData()
-    {
-        return $this->decoded_data;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getEncodedData(): string
-    {
-        return $this->encoded_data;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return int
-     */
-    public function getLastErrorCode(bool $reset = false): int
-    {
-        $last_error = $this->last_error_code;
-        if ($reset) {
-            $this->resetErrors();
-        }
-        return $last_error;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     */
-    public function getLastErrorMessage(bool $reset = false): string
-    {
-        $last_error = $this->last_error_msg;
-        if ($reset) {
-            $this->resetErrors();
-        }
-        return $last_error;
-    }
-
-
-    /**
-     * @param array|string $maybe_json
-     * @return bool
-     */
-    public function isJson($maybe_json): bool
-    {
-        if (! is_string($maybe_json)) {
-            return false;
-        }
-        $decoded = json_decode($maybe_json, $this->asAssociative(), $this->depth, $this->decode_flags);
-        return json_last_error() === JSON_ERROR_NONE && ! ($decoded === null && ! empty($maybe_json));
-    }
-
-
-    /**
-     * @since $VID:$
-     */
-    public function resetErrors()
-    {
-        $this->last_error_code = JSON_ERROR_NONE;
-        $this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
-    }
+	const DATA_TYPE_ARRAY     = 'array';
+
+	const DATA_TYPE_OBJECT    = 'object';
+
+	const DATA_TYPE_USE_FLAGS = 'flags';
+
+	const NO_ERROR_MSG        = 'No error';
+
+	/**
+	 * @var string
+	 */
+	private $data_type;
+
+	/**
+	 * @var array|stdClass
+	 */
+	private $decoded_data;
+
+	/**
+	 * JSON_BIGINT_AS_STRING,
+	 * JSON_INVALID_UTF8_IGNORE,
+	 * JSON_INVALID_UTF8_SUBSTITUTE,
+	 * JSON_OBJECT_AS_ARRAY,
+	 * JSON_THROW_ON_ERROR
+	 *
+	 * @var int
+	 */
+	private $decode_flags;
+
+	/**
+	 * @var int
+	 */
+	private $depth;
+
+	/**
+	 * @var string
+	 */
+	private $encoded_data;
+
+	/**
+	 * JSON_FORCE_OBJECT,
+	 * JSON_HEX_QUOT,
+	 * JSON_HEX_TAG,
+	 * JSON_HEX_AMP,
+	 * JSON_HEX_APOS,
+	 * JSON_INVALID_UTF8_IGNORE,
+	 * JSON_INVALID_UTF8_SUBSTITUTE,
+	 * JSON_NUMERIC_CHECK,
+	 * JSON_PARTIAL_OUTPUT_ON_ERROR,
+	 * JSON_PRESERVE_ZERO_FRACTION,
+	 * JSON_PRETTY_PRINT,
+	 * JSON_UNESCAPED_LINE_TERMINATORS,
+	 * JSON_UNESCAPED_SLASHES,
+	 * JSON_UNESCAPED_UNICODE,
+	 * JSON_THROW_ON_ERROR.
+	 *
+	 * @var int
+	 */
+	private $encode_flags;
+
+	/**
+	 * @var int
+	 */
+	private $last_error_code = JSON_ERROR_NONE;
+
+	/**
+	 * @var string
+	 */
+	private $last_error_msg = JsonDataHandler::NO_ERROR_MSG;
+
+
+	/**
+	 * JsonDataHandler constructor.
+	 */
+	public function __construct()
+	{
+		if (! defined('JSON_INVALID_UTF8_IGNORE')) {
+			define('JSON_INVALID_UTF8_IGNORE', 1048576);
+		}
+		if (! defined('JSON_INVALID_UTF8_SUBSTITUTE')) {
+			define('JSON_INVALID_UTF8_SUBSTITUTE', 2097152);
+		}
+		if (! defined('JSON_THROW_ON_ERROR')) {
+			define('JSON_THROW_ON_ERROR', 4194304);
+		}
+	}
+
+
+	/**
+	 * set $data_type, $decode_flags, $encode_flags, and depth all in one shot
+	 *
+	 * @param string $data_type
+	 * @param int    $decode_flags
+	 * @param int    $encode_flags
+	 * @param int    $depth
+	 */
+	public function configure(
+		string $data_type = JsonDataHandler::DATA_TYPE_USE_FLAGS,
+		int $decode_flags = 0,
+		int $encode_flags = 0,
+		int $depth = 512
+	) {
+		$this->setDataType($data_type);
+		$this->setDecodeFlags($decode_flags);
+		$this->setDepth($depth);
+		$this->setEncodeFlags($encode_flags);
+	}
+
+
+	/**
+	 * @param string $data_type
+	 */
+	public function setDataType(string $data_type): void
+	{
+		$this->data_type = $data_type === JsonDataHandler::DATA_TYPE_ARRAY
+						   || $data_type === JsonDataHandler::DATA_TYPE_OBJECT
+						   || $data_type === JsonDataHandler::DATA_TYPE_USE_FLAGS
+			? $data_type
+			: JsonDataHandler::DATA_TYPE_USE_FLAGS;
+	}
+
+
+	/**
+	 * One or more Bitmask values:
+	 * JSON_BIGINT_AS_STRING,
+	 * JSON_INVALID_UTF8_IGNORE,        PHP >= 7.2
+	 * JSON_INVALID_UTF8_SUBSTITUTE,    PHP >= 7.2
+	 * JSON_OBJECT_AS_ARRAY,
+	 * JSON_THROW_ON_ERROR              PHP >= 7.3
+	 *
+	 * pass multiple values separated with |
+	 * ex: JSON_BIGINT_AS_STRING | JSON_INVALID_UTF8_IGNORE | JSON_OBJECT_AS_ARRAY
+	 *
+	 * @param int $decode_flags
+	 */
+	public function setDecodeFlags(int $decode_flags): void
+	{
+		$this->decode_flags = $decode_flags === JSON_BIGINT_AS_STRING
+							  || $decode_flags === JSON_OBJECT_AS_ARRAY
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_ignoreFound
+							  || $decode_flags === JSON_INVALID_UTF8_IGNORE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_substituteFound
+							  || $decode_flags === JSON_INVALID_UTF8_SUBSTITUTE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_throw_on_errorFound
+							  || $decode_flags === JSON_THROW_ON_ERROR
+			? $decode_flags
+			: 0;
+	}
+
+
+	/**
+	 * @param int $depth
+	 */
+	public function setDepth(int $depth): void
+	{
+		$depth       = absint($depth);
+		$this->depth = $depth ?: 512;
+	}
+
+
+	/**
+	 * One or more Bitmask values:
+	 * JSON_FORCE_OBJECT,
+	 * JSON_HEX_QUOT,
+	 * JSON_HEX_TAG,
+	 * JSON_HEX_AMP,
+	 * JSON_HEX_APOS,
+	 * JSON_INVALID_UTF8_IGNORE,        PHP >= 7.2
+	 * JSON_INVALID_UTF8_SUBSTITUTE,    PHP >= 7.2
+	 * JSON_NUMERIC_CHECK,
+	 * JSON_PARTIAL_OUTPUT_ON_ERROR,
+	 * JSON_PRESERVE_ZERO_FRACTION,
+	 * JSON_PRETTY_PRINT,
+	 * JSON_UNESCAPED_LINE_TERMINATORS,
+	 * JSON_UNESCAPED_SLASHES,
+	 * JSON_UNESCAPED_UNICODE,
+	 * JSON_THROW_ON_ERROR.             PHP >= 7.3
+	 *
+	 * pass multiple values separated with |
+	 * ex: JSON_FORCE_OBJECT | JSON_INVALID_UTF8_IGNORE | JSON_THROW_ON_ERROR
+	 *
+	 * @param int $encode_flags
+	 */
+	public function setEncodeFlags(int $encode_flags): void
+	{
+		$this->encode_flags = $encode_flags === JSON_FORCE_OBJECT
+							  || $encode_flags === JSON_HEX_QUOT
+							  || $encode_flags === JSON_HEX_TAG
+							  || $encode_flags === JSON_HEX_AMP
+							  || $encode_flags === JSON_HEX_APOS
+							  || $encode_flags === JSON_NUMERIC_CHECK
+							  || $encode_flags === JSON_PARTIAL_OUTPUT_ON_ERROR
+							  || $encode_flags === JSON_PRESERVE_ZERO_FRACTION
+							  || $encode_flags === JSON_PRETTY_PRINT
+							  || $encode_flags === JSON_UNESCAPED_LINE_TERMINATORS
+							  || $encode_flags === JSON_UNESCAPED_SLASHES
+							  || $encode_flags === JSON_UNESCAPED_UNICODE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_ignoreFound
+							  || $encode_flags === JSON_INVALID_UTF8_IGNORE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_substituteFound
+							  || $encode_flags === JSON_INVALID_UTF8_SUBSTITUTE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_throw_on_errorFound
+							  || $encode_flags === JSON_THROW_ON_ERROR
+			? $encode_flags
+			: 0;
+	}
+
+
+	/**
+	 * @return bool|null
+	 */
+	private function asAssociative(): ?bool
+	{
+		switch ($this->data_type) {
+			case JsonDataHandler::DATA_TYPE_ARRAY:
+				return true;
+			case JsonDataHandler::DATA_TYPE_OBJECT:
+				return false;
+			case JsonDataHandler::DATA_TYPE_USE_FLAGS:
+				return null;
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param array|string $json
+	 * @return array|mixed|stdClass
+	 */
+	public function decodeJson($json)
+	{
+		$this->resetErrors();
+		if ($this->isJson($json)) {
+			$this->decoded_data    = json_decode($json, $this->asAssociative(), $this->depth, $this->decode_flags);
+			$this->last_error_code = json_last_error();
+			$this->last_error_msg  = json_last_error_msg();
+		} else {
+			$this->decoded_data    = $json;
+			$this->last_error_code = JSON_ERROR_NONE;
+			$this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
+		}
+		return $this->decoded_data;
+	}
+
+
+	/**
+	 * @param $data
+	 * @return string
+	 */
+	public function encodeData($data): string
+	{
+		$this->resetErrors();
+		if ($this->isJson($data)) {
+			$this->encoded_data = $data;
+			$this->last_error_code = JSON_ERROR_NONE;
+			$this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
+		} else {
+			$this->encoded_data = json_encode($data, $this->encode_flags, $this->depth);
+			$this->last_error_code = json_last_error();
+			$this->last_error_msg  = json_last_error_msg();
+		}
+		return $this->encoded_data ?: '{}';
+	}
+
+
+	/**
+	 * @return array|stdClass
+	 */
+	public function getDecodedData()
+	{
+		return $this->decoded_data;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getEncodedData(): string
+	{
+		return $this->encoded_data;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return int
+	 */
+	public function getLastErrorCode(bool $reset = false): int
+	{
+		$last_error = $this->last_error_code;
+		if ($reset) {
+			$this->resetErrors();
+		}
+		return $last_error;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 */
+	public function getLastErrorMessage(bool $reset = false): string
+	{
+		$last_error = $this->last_error_msg;
+		if ($reset) {
+			$this->resetErrors();
+		}
+		return $last_error;
+	}
+
+
+	/**
+	 * @param array|string $maybe_json
+	 * @return bool
+	 */
+	public function isJson($maybe_json): bool
+	{
+		if (! is_string($maybe_json)) {
+			return false;
+		}
+		$decoded = json_decode($maybe_json, $this->asAssociative(), $this->depth, $this->decode_flags);
+		return json_last_error() === JSON_ERROR_NONE && ! ($decoded === null && ! empty($maybe_json));
+	}
+
+
+	/**
+	 * @since $VID:$
+	 */
+	public function resetErrors()
+	{
+		$this->last_error_code = JSON_ERROR_NONE;
+		$this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -90,13 +90,13 @@ 
      */
     public function __construct()
     {
-        if (! defined('JSON_INVALID_UTF8_IGNORE')) {
+        if ( ! defined('JSON_INVALID_UTF8_IGNORE')) {
             define('JSON_INVALID_UTF8_IGNORE', 1048576);
         }
-        if (! defined('JSON_INVALID_UTF8_SUBSTITUTE')) {
+        if ( ! defined('JSON_INVALID_UTF8_SUBSTITUTE')) {
             define('JSON_INVALID_UTF8_SUBSTITUTE', 2097152);
         }
-        if (! defined('JSON_THROW_ON_ERROR')) {
+        if ( ! defined('JSON_THROW_ON_ERROR')) {
             define('JSON_THROW_ON_ERROR', 4194304);
         }
     }
@@ -331,7 +331,7 @@ 
      */
     public function isJson($maybe_json): bool
     {
-        if (! is_string($maybe_json)) {
+        if ( ! is_string($maybe_json)) {
             return false;
         }
         $decoded = json_decode($maybe_json, $this->asAssociative(), $this->depth, $this->decode_flags);

core/db_classes/EE_Form_Submission.class.php

Indentation +148 added lines, -148 removed lines

@@ -5,152 +5,152 @@
 class EE_Form_Submission extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Form_Submission
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance(array $props_n_values = []): EE_Form_Submission
-    {
-        $props_n_values['FSB_submitted'] = new DateTime();
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ?: new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Form_Submission
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db(array $props_n_values = []): EE_Form_Submission
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Form Section UUID (universally unique identifier)
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function UUID(): string
-    {
-        return $this->get('FSB_UUID');
-    }
-
-
-    /**
-     * @param string $UUID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setUUID(string $UUID)
-    {
-        $this->set('FSB_UUID', $UUID);
-    }
-
-
-    /**
-     * UUID or ID of related entity this form submission belongs to.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function formSection(): string
-    {
-        return $this->get('FSC_UUID');
-    }
-
-
-    /**
-     * @param string $form_section_UUID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setFormSection(string $form_section_UUID)
-    {
-        $this->set('FSC_UUID', $form_section_UUID);
-    }
-
-
-    /**
-     * Returns the related EE_Transaction this form submission belongs to.
-     *
-     * @return EE_Transaction
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws ReflectionException
-     */
-    public function transaction(): EE_Transaction
-    {
-        $transaction = $this->get_first_related('Transaction');
-        if (! $transaction instanceof EE_Transaction) {
-            throw new EntityNotFoundException('Transaction ID', $this->transactionID());
-        }
-        return $transaction;
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function transactionID(): int
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * @param int $TXN_ID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setTransactionID(int $TXN_ID = 0)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function data()
-    {
-        return $this->get('FSB_data');
-    }
-
-
-    /**
-     * @param array|string $data
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setData($data)
-    {
-        $this->set('FSB_data', $data);
-    }
-
-
-    /**
-     * @param bool $raw
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function submitted(bool $raw = false): int
-    {
-        return $raw
-            ? $this->get_raw('FSB_submitted')
-            : $this->get('FSB_submitted');
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Form_Submission
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance(array $props_n_values = []): EE_Form_Submission
+	{
+		$props_n_values['FSB_submitted'] = new DateTime();
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ?: new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Form_Submission
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db(array $props_n_values = []): EE_Form_Submission
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Form Section UUID (universally unique identifier)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function UUID(): string
+	{
+		return $this->get('FSB_UUID');
+	}
+
+
+	/**
+	 * @param string $UUID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setUUID(string $UUID)
+	{
+		$this->set('FSB_UUID', $UUID);
+	}
+
+
+	/**
+	 * UUID or ID of related entity this form submission belongs to.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function formSection(): string
+	{
+		return $this->get('FSC_UUID');
+	}
+
+
+	/**
+	 * @param string $form_section_UUID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setFormSection(string $form_section_UUID)
+	{
+		$this->set('FSC_UUID', $form_section_UUID);
+	}
+
+
+	/**
+	 * Returns the related EE_Transaction this form submission belongs to.
+	 *
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws ReflectionException
+	 */
+	public function transaction(): EE_Transaction
+	{
+		$transaction = $this->get_first_related('Transaction');
+		if (! $transaction instanceof EE_Transaction) {
+			throw new EntityNotFoundException('Transaction ID', $this->transactionID());
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function transactionID(): int
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * @param int $TXN_ID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setTransactionID(int $TXN_ID = 0)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function data()
+	{
+		return $this->get('FSB_data');
+	}
+
+
+	/**
+	 * @param array|string $data
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setData($data)
+	{
+		$this->set('FSB_data', $data);
+	}
+
+
+	/**
+	 * @param bool $raw
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function submitted(bool $raw = false): int
+	{
+		return $raw
+			? $this->get_raw('FSB_submitted')
+			: $this->get('FSB_submitted');
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
     public function transaction(): EE_Transaction
     {
         $transaction = $this->get_first_related('Transaction');
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             throw new EntityNotFoundException('Transaction ID', $this->transactionID());
         }
         return $transaction;

core/services/form/meta/HelpText.php

Spacing +2 added lines, -2 removed lines

@@ -131,7 +131,7 @@ 
     public function addHtmlClass(string $htmlClass): void
     {
         $htmlClass = sanitize_key($htmlClass);
-        if (! in_array($htmlClass, $this->htmlClasses, true)) {
+        if ( ! in_array($htmlClass, $this->htmlClasses, true)) {
             $this->htmlClasses[] = $htmlClass;
         }
     }
@@ -143,7 +143,7 @@ 
     public function removeHtmlClass(string $htmlClass): void
     {
         $htmlClass = sanitize_key($htmlClass);
-        unset($this->htmlClasses[ $htmlClass ]);
+        unset($this->htmlClasses[$htmlClass]);
     }
 
 

Indentation +137 added lines, -137 removed lines

@@ -15,141 +15,141 @@
 class HelpText implements JsonableInterface
 {
 
-    /**
-     * @var JsonDataHandler
-     */
-    private $json_data_handler;
-
-    /**
-     * Additional text displayed alongside a form input to assist users with completing the form.
-     *
-     * @var string
-     */
-    private $helpText;
-
-    /**
-     * Custom HTML classes to be applied to this form input's help text.
-     *
-     * @var array
-     */
-    private $htmlClasses;
-
-
-    /**
-     * HelpText constructor.
-     *
-     * @param JsonDataHandler $json_data_handler
-     * @param array           $htmlClass
-     * @param string          $helpText
-     */
-    public function __construct(
-        JsonDataHandler $json_data_handler,
-        array $htmlClass,
-        string $helpText
-    ) {
-        $this->json_data_handler = $json_data_handler;
-        $this->setHtmlClasses($htmlClass);
-        $this->setHelpText($helpText);
-    }
-
-
-    /**
-     * @param string $json
-     * @return HelpText
-     */
-    public static function fromJson(string $json): HelpText
-    {
-        $json_data_handler = new JsonDataHandler();
-        $json_data_handler->configure(JsonDataHandler::DATA_TYPE_OBJECT);
-        $data      = $json_data_handler->decodeJson($json);
-        $htmlClass = (array) ($data->htmlClass ?? []);
-        $helpText  = $data->helpText ?? '';
-        return new HelpText($json_data_handler, $htmlClass, $helpText);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function toArray(): array
-    {
-        return [
-            'helpText'  => $this->helpText,
-            'htmlClass' => $this->htmlClasses(),
-        ];
-    }
-
-
-    /**
-     * @return string
-     */
-    public function toJson(): string
-    {
-        return $this->json_data_handler->encodeData($this->toArray());
-    }
-
-
-    /**
-     * Input label displayed on public forms, ie: the actual question text.
-     *
-     * @return string
-     */
-    public function helpText(): string
-    {
-        return $this->helpText;
-    }
-
-
-    /**
-     * @param string $helpText
-     */
-    public function setHelpText(string $helpText): void
-    {
-        $this->helpText = sanitize_text_field($helpText);
-    }
-
-
-    /**
-     * Custom HTML classes to be applied to this form input's help text.
-     * returns a concatenated string unless $as_array is set to true
-     *
-     * @return array|string
-     */
-    public function htmlClasses($as_array = false)
-    {
-        return $as_array
-            ? $this->htmlClasses
-            : implode(' ', $this->htmlClasses);
-    }
-
-
-    /**
-     * @param string $htmlClass
-     */
-    public function addHtmlClass(string $htmlClass): void
-    {
-        $htmlClass = sanitize_key($htmlClass);
-        if (! in_array($htmlClass, $this->htmlClasses, true)) {
-            $this->htmlClasses[] = $htmlClass;
-        }
-    }
-
-
-    /**
-     * @param string $htmlClass
-     */
-    public function removeHtmlClass(string $htmlClass): void
-    {
-        $htmlClass = sanitize_key($htmlClass);
-        unset($this->htmlClasses[ $htmlClass ]);
-    }
-
-
-    /**
-     * @param array $htmlClasses
-     */
-    public function setHtmlClasses(array $htmlClasses): void
-    {
-        $this->htmlClasses = array_map('sanitize_key', $htmlClasses);
-    }
+	/**
+	 * @var JsonDataHandler
+	 */
+	private $json_data_handler;
+
+	/**
+	 * Additional text displayed alongside a form input to assist users with completing the form.
+	 *
+	 * @var string
+	 */
+	private $helpText;
+
+	/**
+	 * Custom HTML classes to be applied to this form input's help text.
+	 *
+	 * @var array
+	 */
+	private $htmlClasses;
+
+
+	/**
+	 * HelpText constructor.
+	 *
+	 * @param JsonDataHandler $json_data_handler
+	 * @param array           $htmlClass
+	 * @param string          $helpText
+	 */
+	public function __construct(
+		JsonDataHandler $json_data_handler,
+		array $htmlClass,
+		string $helpText
+	) {
+		$this->json_data_handler = $json_data_handler;
+		$this->setHtmlClasses($htmlClass);
+		$this->setHelpText($helpText);
+	}
+
+
+	/**
+	 * @param string $json
+	 * @return HelpText
+	 */
+	public static function fromJson(string $json): HelpText
+	{
+		$json_data_handler = new JsonDataHandler();
+		$json_data_handler->configure(JsonDataHandler::DATA_TYPE_OBJECT);
+		$data      = $json_data_handler->decodeJson($json);
+		$htmlClass = (array) ($data->htmlClass ?? []);
+		$helpText  = $data->helpText ?? '';
+		return new HelpText($json_data_handler, $htmlClass, $helpText);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function toArray(): array
+	{
+		return [
+			'helpText'  => $this->helpText,
+			'htmlClass' => $this->htmlClasses(),
+		];
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function toJson(): string
+	{
+		return $this->json_data_handler->encodeData($this->toArray());
+	}
+
+
+	/**
+	 * Input label displayed on public forms, ie: the actual question text.
+	 *
+	 * @return string
+	 */
+	public function helpText(): string
+	{
+		return $this->helpText;
+	}
+
+
+	/**
+	 * @param string $helpText
+	 */
+	public function setHelpText(string $helpText): void
+	{
+		$this->helpText = sanitize_text_field($helpText);
+	}
+
+
+	/**
+	 * Custom HTML classes to be applied to this form input's help text.
+	 * returns a concatenated string unless $as_array is set to true
+	 *
+	 * @return array|string
+	 */
+	public function htmlClasses($as_array = false)
+	{
+		return $as_array
+			? $this->htmlClasses
+			: implode(' ', $this->htmlClasses);
+	}
+
+
+	/**
+	 * @param string $htmlClass
+	 */
+	public function addHtmlClass(string $htmlClass): void
+	{
+		$htmlClass = sanitize_key($htmlClass);
+		if (! in_array($htmlClass, $this->htmlClasses, true)) {
+			$this->htmlClasses[] = $htmlClass;
+		}
+	}
+
+
+	/**
+	 * @param string $htmlClass
+	 */
+	public function removeHtmlClass(string $htmlClass): void
+	{
+		$htmlClass = sanitize_key($htmlClass);
+		unset($this->htmlClasses[ $htmlClass ]);
+	}
+
+
+	/**
+	 * @param array $htmlClasses
+	 */
+	public function setHtmlClasses(array $htmlClasses): void
+	{
+		$this->htmlClasses = array_map('sanitize_key', $htmlClasses);
+	}
 }

core/db_models/EEM_Answer.model.php

Indentation +129 added lines, -129 removed lines

@@ -10,145 +10,145 @@
 class EEM_Answer extends EEM_Base
 {
 
-    /**
-     * private instance of the EEM_Answer object
-     * @type EEM_Answer
-     */
-    protected static $_instance = null;
+	/**
+	 * private instance of the EEM_Answer object
+	 * @type EEM_Answer
+	 */
+	protected static $_instance = null;
 
-    /**
-     * Mapping from system question ids to attendee field names
-     * @type array
-     * @deprecated since version 4.8.8
-     */
-    protected $_question_id_to_att_field_map = array(
-        EEM_Attendee::fname_question_id => 'ATT_fname',
-        EEM_Attendee::lname_question_id => 'ATT_lname',
-        EEM_Attendee::email_question_id => 'ATT_email',
-        EEM_Attendee::address_question_id => 'ATT_address',
-        EEM_Attendee::address2_question_id => 'ATT_address2',
-        EEM_Attendee::city_question_id => 'ATT_city',
-        EEM_Attendee::state_question_id => 'STA_ID',
-        EEM_Attendee::country_question_id => 'CNT_ISO',
-        EEM_Attendee::zip_question_id => 'ATT_zip',
-        EEM_Attendee::phone_question_id => 'ATT_phone'
-    );
+	/**
+	 * Mapping from system question ids to attendee field names
+	 * @type array
+	 * @deprecated since version 4.8.8
+	 */
+	protected $_question_id_to_att_field_map = array(
+		EEM_Attendee::fname_question_id => 'ATT_fname',
+		EEM_Attendee::lname_question_id => 'ATT_lname',
+		EEM_Attendee::email_question_id => 'ATT_email',
+		EEM_Attendee::address_question_id => 'ATT_address',
+		EEM_Attendee::address2_question_id => 'ATT_address2',
+		EEM_Attendee::city_question_id => 'ATT_city',
+		EEM_Attendee::state_question_id => 'STA_ID',
+		EEM_Attendee::country_question_id => 'CNT_ISO',
+		EEM_Attendee::zip_question_id => 'ATT_zip',
+		EEM_Attendee::phone_question_id => 'ATT_phone'
+	);
 
 
 
-    /**
-     *  constructor
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Answer', 'event_espresso');
-        $this->plural_item = __('Answers', 'event_espresso');
-        $this->_tables = array(
-            'Answer' => new EE_Primary_Table('esp_answer', 'ANS_ID')
-        );
-        $this->_fields = array(
-            'Answer' => array(
-                'ANS_ID' => new EE_Primary_Key_Int_Field('ANS_ID', __('Answer ID', 'event_espresso')),
-                'REG_ID' => new EE_Foreign_Key_Int_Field('REG_ID', __('Registration ID', 'event_espresso'), false, 0, 'Registration'),
-                'QST_ID' => new EE_Foreign_Key_Int_Field('QST_ID', __('Question ID', 'event_espresso'), false, 0, 'Question'),
-                'ANS_value' => new EE_Maybe_Serialized_Simple_HTML_Field('ANS_value', __('Answer Value', 'event_espresso'), false, '')
-            ));
-        $this->_model_relations = array(
-            'Registration' => new EE_Belongs_To_Relation(),
-            'Question' => new EE_Belongs_To_Relation()
-        );
-        $this->_model_chain_to_wp_user = 'Registration.Event';
-        $this->_caps_slug = 'registrations';
-        parent::__construct($timezone);
-    }
+	/**
+	 *  constructor
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Answer', 'event_espresso');
+		$this->plural_item = __('Answers', 'event_espresso');
+		$this->_tables = array(
+			'Answer' => new EE_Primary_Table('esp_answer', 'ANS_ID')
+		);
+		$this->_fields = array(
+			'Answer' => array(
+				'ANS_ID' => new EE_Primary_Key_Int_Field('ANS_ID', __('Answer ID', 'event_espresso')),
+				'REG_ID' => new EE_Foreign_Key_Int_Field('REG_ID', __('Registration ID', 'event_espresso'), false, 0, 'Registration'),
+				'QST_ID' => new EE_Foreign_Key_Int_Field('QST_ID', __('Question ID', 'event_espresso'), false, 0, 'Question'),
+				'ANS_value' => new EE_Maybe_Serialized_Simple_HTML_Field('ANS_value', __('Answer Value', 'event_espresso'), false, '')
+			));
+		$this->_model_relations = array(
+			'Registration' => new EE_Belongs_To_Relation(),
+			'Question' => new EE_Belongs_To_Relation()
+		);
+		$this->_model_chain_to_wp_user = 'Registration.Event';
+		$this->_caps_slug = 'registrations';
+		parent::__construct($timezone);
+	}
 
 
 
-    /**
-     * Gets the string answer to the question for this registration (it could either be stored
-     * on the attendee or in the answer table. This function finds its value regardless)
-     * @param EE_Registration $registration
-     * @param int $question_id
-     * @param boolean $pretty_answer whether to call 'pretty_value' or just 'value'
-     * @return string
-     */
-    public function get_answer_value_to_question(EE_Registration $registration, $question_id = null, $pretty_answer = false)
-    {
-        $value = $this->get_attendee_property_answer_value($registration, $question_id, $pretty_answer);
-        if ($value === null) {
-            $answer_obj = $this->get_registration_question_answer_object($registration, $question_id);
-            if ($answer_obj instanceof EE_Answer) {
-                if ($pretty_answer) {
-                    $value = $answer_obj->pretty_value();
-                } else {
-                    $value = $answer_obj->value();
-                }
-            }
-        }
-        return apply_filters('FHEE__EEM_Answer__get_answer_value_to_question__answer_value', $value, $registration, $question_id);
-    }
+	/**
+	 * Gets the string answer to the question for this registration (it could either be stored
+	 * on the attendee or in the answer table. This function finds its value regardless)
+	 * @param EE_Registration $registration
+	 * @param int $question_id
+	 * @param boolean $pretty_answer whether to call 'pretty_value' or just 'value'
+	 * @return string
+	 */
+	public function get_answer_value_to_question(EE_Registration $registration, $question_id = null, $pretty_answer = false)
+	{
+		$value = $this->get_attendee_property_answer_value($registration, $question_id, $pretty_answer);
+		if ($value === null) {
+			$answer_obj = $this->get_registration_question_answer_object($registration, $question_id);
+			if ($answer_obj instanceof EE_Answer) {
+				if ($pretty_answer) {
+					$value = $answer_obj->pretty_value();
+				} else {
+					$value = $answer_obj->value();
+				}
+			}
+		}
+		return apply_filters('FHEE__EEM_Answer__get_answer_value_to_question__answer_value', $value, $registration, $question_id);
+	}
 
 
 
-    /**
-     * Gets the EE_Answer object for the question for this registration (if it exists)
-     * @param EE_Registration $registration
-     * @param int $question_id
-     * @return EE_Answer
-     */
-    public function get_registration_question_answer_object(EE_Registration $registration, $question_id = null)
-    {
-        $answer_obj = $this->get_one(array( array( 'QST_ID' => $question_id, 'REG_ID' => $registration->ID() )));
-        return apply_filters('FHEE__EEM_Answer__get_registration_question_answer_object__answer_obj', $answer_obj, $registration, $question_id);
-    }
+	/**
+	 * Gets the EE_Answer object for the question for this registration (if it exists)
+	 * @param EE_Registration $registration
+	 * @param int $question_id
+	 * @return EE_Answer
+	 */
+	public function get_registration_question_answer_object(EE_Registration $registration, $question_id = null)
+	{
+		$answer_obj = $this->get_one(array( array( 'QST_ID' => $question_id, 'REG_ID' => $registration->ID() )));
+		return apply_filters('FHEE__EEM_Answer__get_registration_question_answer_object__answer_obj', $answer_obj, $registration, $question_id);
+	}
 
 
-    /**
-     * Gets the string answer to the question for this registration's attendee
-     *
-     * @param EE_Registration $registration
-     * @param int|string      $question_system_id if an INT this is understood to be the question's ID; if a string
-     *                                            then it should be its QST_system value. Passing in the QST_system
-     *                                            value is more efficient
-     * @param boolean         $pretty_answer
-     * @return string|null (if the registration has no attendee, or the question_system_id is not a QST_ID or
-     *                                            QST_system for a question corresponding to an attendee field, returns
-     *                                            null)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_attendee_property_answer_value(EE_Registration $registration, $question_system_id = null, $pretty_answer = false)
-    {
-        $value = null;
-        // backward compat: we still want to find the question's ID
-        if (is_numeric($question_system_id)) {
-            // find this question's QST_system value
-            $question_id = $question_system_id;
-            $question_system_id = EEM_Question::instance()->get_var(array( array( 'QST_ID' => $question_system_id ) ), 'QST_system');
-        } else {
-            $question_id = (int) EEM_Question::instance()->get_var(array( array( 'QST_system' => $question_system_id ) ), 'QST_ID');
-        }
-        // only bother checking if the registration has an attendee
-        if ($registration->attendee() instanceof EE_Attendee) {
-            $field_name = EEM_Attendee::instance()->get_attendee_field_for_system_question($question_system_id);
-            if ($field_name) {
-                if ($pretty_answer) {
-                    if ($field_name === 'STA_ID') {
-                        $state = $registration->attendee()->state_obj();
-                        $value = $state instanceof EE_State ? $state->name() : sprintf(__('Unknown State (%s)', 'event_espresso'), $registration->attendee()->state_ID());
-                    } elseif ($field_name === 'CNT_ISO') {
-                        $country = $registration->attendee()->country_obj();
-                        $value = $country instanceof EE_Country ? $country->name() : sprintf(__('Unknown Country (%s)', "event_espresso"), $registration->attendee()->country_ID());
-                    } else {
-                        $value = $registration->attendee()->get_pretty($field_name);
-                    }
-                    // if field name is blank, leave the value as null too
-                } else {
-                    $value = $registration->attendee()->get($field_name);
-                }
-            }
-            // if no field was found, leave value blank
-        }
-        return apply_filters('FHEE__EEM_Answer__get_attendee_question_answer_value__answer_value', $value, $registration, $question_id, $question_system_id);
-    }
+	/**
+	 * Gets the string answer to the question for this registration's attendee
+	 *
+	 * @param EE_Registration $registration
+	 * @param int|string      $question_system_id if an INT this is understood to be the question's ID; if a string
+	 *                                            then it should be its QST_system value. Passing in the QST_system
+	 *                                            value is more efficient
+	 * @param boolean         $pretty_answer
+	 * @return string|null (if the registration has no attendee, or the question_system_id is not a QST_ID or
+	 *                                            QST_system for a question corresponding to an attendee field, returns
+	 *                                            null)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_attendee_property_answer_value(EE_Registration $registration, $question_system_id = null, $pretty_answer = false)
+	{
+		$value = null;
+		// backward compat: we still want to find the question's ID
+		if (is_numeric($question_system_id)) {
+			// find this question's QST_system value
+			$question_id = $question_system_id;
+			$question_system_id = EEM_Question::instance()->get_var(array( array( 'QST_ID' => $question_system_id ) ), 'QST_system');
+		} else {
+			$question_id = (int) EEM_Question::instance()->get_var(array( array( 'QST_system' => $question_system_id ) ), 'QST_ID');
+		}
+		// only bother checking if the registration has an attendee
+		if ($registration->attendee() instanceof EE_Attendee) {
+			$field_name = EEM_Attendee::instance()->get_attendee_field_for_system_question($question_system_id);
+			if ($field_name) {
+				if ($pretty_answer) {
+					if ($field_name === 'STA_ID') {
+						$state = $registration->attendee()->state_obj();
+						$value = $state instanceof EE_State ? $state->name() : sprintf(__('Unknown State (%s)', 'event_espresso'), $registration->attendee()->state_ID());
+					} elseif ($field_name === 'CNT_ISO') {
+						$country = $registration->attendee()->country_obj();
+						$value = $country instanceof EE_Country ? $country->name() : sprintf(__('Unknown Country (%s)', "event_espresso"), $registration->attendee()->country_ID());
+					} else {
+						$value = $registration->attendee()->get_pretty($field_name);
+					}
+					// if field name is blank, leave the value as null too
+				} else {
+					$value = $registration->attendee()->get($field_name);
+				}
+			}
+			// if no field was found, leave value blank
+		}
+		return apply_filters('FHEE__EEM_Answer__get_attendee_question_answer_value__answer_value', $value, $registration, $question_id, $question_system_id);
+	}
 }

core/db_models/EEM_Form_Section.model.php

Spacing +4 added lines, -4 removed lines

@@ -152,10 +152,10 @@
         ];
         // this model is generally available for reading
         $restrictions                              = [];
-        $restrictions[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Public();
-        $restrictions[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
-        $restrictions[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
-        $restrictions[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
+        $restrictions[EEM_Base::caps_read]       = new EE_Restriction_Generator_Public();
+        $restrictions[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
+        $restrictions[EEM_Base::caps_edit]       = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
+        $restrictions[EEM_Base::caps_delete]     = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
         $this->_cap_restriction_generators         = $restrictions;
         parent::__construct($timezone);
         $this->request = $this->getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');

Indentation +228 added lines, -228 removed lines

@@ -21,232 +21,232 @@
  */
 class EEM_Form_Section extends EEM_Base
 {
-    public const APPLIES_TO_ALL         = 'all';
-
-    public const APPLIES_TO_PRIMARY     = 'primary';
-
-    public const APPLIES_TO_PURCHASER   = 'purchaser';
-
-    public const APPLIES_TO_REGISTRANTS = 'registrants';
-
-    /**
-     * @var EEM_Form_Section
-     */
-    protected static $_instance;
-
-    /**
-     * @var RequestInterface
-     */
-    private $request;
-
-    /**
-     * @var array
-     */
-    private $valid_applies_to_options;
-
-
-    /**
-     * EEM_Form_Section constructor.
-     *
-     * @param FormStatus  $form_status
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(FormStatus $form_status, ?string $timezone)
-    {
-        $this->valid_applies_to_options = apply_filters(
-            'FHEE__EEM_Form_Section__valid_applies_to_options',
-            [
-                EEM_Form_Section::APPLIES_TO_ALL         => esc_html__('All Registrants', 'event_espresso'),
-                EEM_Form_Section::APPLIES_TO_PRIMARY     => esc_html__('Primary Registrant Only', 'event_espresso'),
-                EEM_Form_Section::APPLIES_TO_PURCHASER   => esc_html__('Purchasing Agent', 'event_espresso'),
-                EEM_Form_Section::APPLIES_TO_REGISTRANTS => esc_html__('Additional Registrants', 'event_espresso'),
-            ]
-        );
-
-        $this->singular_item = esc_html__('Form Section', 'event_espresso');
-        $this->plural_item   = esc_html__('Form Sections', 'event_espresso');
-
-        $this->_tables          = [
-            'Form_Section' => new EE_Primary_Table('esp_form_section', 'FSC_UUID'),
-        ];
-        $this->_fields          = [
-            'Form_Section' => [
-                'FSC_UUID'      => new EE_Primary_Key_String_Field(
-                    'FSC_UUID',
-                    esc_html__('Form Section UUID (universally unique identifier)', 'event_espresso')
-                ),
-                'FSC_appliesTo' => new EE_Enum_Text_Field(
-                    'FSC_appliesTo',
-                    esc_html(
-                        sprintf(
-                            /* translators: 1 class name */
-                            __(
-                                'Form user type that this form section should be presented to. Values correspond to the %s constants.',
-                                'event_espresso'
-                            ),
-                            'EEM_Form_Section::APPLIES_TO_*'
-                        )
-                    ),
-                    false,
-                    EEM_Form_Section::APPLIES_TO_ALL,
-                    $this->valid_applies_to_options
-                ),
-                'FSC_attributes' => new EE_JSON_Field(
-                    'FSC_attributes',
-                    esc_html__(
-                        'JSON string of HTML attributes, such as class, to be applied to this form section\'s container.',
-                        'event_espresso'
-                    ),
-                    true,
-                    '{}'
-                ),
-                'FSC_belongsTo' => new EE_Plain_Text_Field(
-                    'FSC_belongsTo',
-                    esc_html__('UUID of parent form section that this one belongs to.', 'event_espresso'),
-                    true,
-                    null
-                ),
-                'FSC_label' => new EE_JSON_Field(
-                    'FSC_label',
-                    esc_html__(
-                        'JSON string of properties pertaining to a form section\'s label.',
-                        'event_espresso'
-                    ),
-                    true,
-                    '{}'
-                ),
-                'FSC_order'     => new EE_Integer_Field(
-                    'FSC_order',
-                    esc_html__('Order in which form section appears in a form.', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'FSC_status'    => new EE_Enum_Text_Field(
-                    'FSC_status',
-                    esc_html(
-                        sprintf(
-                            /* translators: 1 class name */
-                            __(
-                                'Whether form section is active, archived, shared, trashed, or used as a default on new forms. Values correspond to the %1$s class constants.',
-                                'event_espresso'
-                            ),
-                            'EventEspresso\core\services\form\meta\FormStatus'
-                        )
-                    ),
-                    false,
-                    FormStatus::ACTIVE,
-                    $form_status->validStatusOptions()
-                ),
-                'FSC_wpUser'    => new EE_WP_User_Field(
-                    'FSC_wpUser',
-                    esc_html__('ID of the WP User that created this form section.', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Form_Element' => new EE_Has_Many_Relation(),
-            'Form_Submission' => new EE_Has_Many_Relation(),
-            'WP_User'    => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $restrictions                              = [];
-        $restrictions[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Public();
-        $restrictions[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
-        $restrictions[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
-        $restrictions[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
-        $this->_cap_restriction_generators         = $restrictions;
-        parent::__construct($timezone);
-        $this->request = $this->getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return array
-     */
-    private function addDefaultWhereConditions(array $query_params): array
-    {
-        // might need to add a way to identify GQL requests for admin domains
-        $admin_request                            = $this->request->isAdmin() || $this->request->isAdminAjax();
-        $query_params['default_where_conditions'] = $admin_request
-            ? EEM_Base::default_where_conditions_none
-            : EEM_Base::default_where_conditions_all;
-        return $query_params;
-    }
-
-
-    /**
-     * form sections should always be sorted in ascending order via the FSC_order field
-     *
-     * @param array $query_params
-     * @return array
-     */
-    private function addOrderByQueryParams(array $query_params): array
-    {
-        $query_params['order_by'] = ['FSC_order' => 'ASC'];
-        return $query_params;
-    }
-
-
-    /**
-     * returns an array of Form Sections for the specified parent Form Section
-     *
-     * @param string $FSC_UUID
-     * @return EE_Form_Section[]
-     * @throws EE_Error
-     */
-    public function getChildFormSections(string $FSC_UUID): array
-    {
-        return $this->getFormSections(['FSC_belongsTo' => $FSC_UUID]);
-    }
-
-
-    /**
-     * @return EE_Form_Section[]
-     * @throws EE_Error
-     */
-    public function getFormSections(array $where_params): array
-    {
-        $query_params = $this->addDefaultWhereConditions([$where_params]);
-        $query_params = $this->addOrderByQueryParams($query_params);
-        return $this->get_all($query_params);
-    }
-
-
-    /**
-     * returns an array of Form Sections for the specified Event
-     *
-     * @param EE_Event $event
-     * @return EE_Form_Section[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getFormSectionsForEvent(EE_Event $event): array
-    {
-        $FSC_UUID = $event->registrationFormUuid();
-        return ! empty($FSC_UUID)
-            ? $this->getFormSections(
-                [
-                    'OR' => [
-                        'FSC_UUID'      => $FSC_UUID, // top level form
-                        'FSC_belongsTo' => $FSC_UUID, // child form sections
-                    ]
-                ]
-            )
-            : [];
-    }
-
-
-    /**
-     * @param bool $constants_only
-     * @return array
-     */
-    public function validAppliesToOptions(bool $constants_only = false): array
-    {
-        return $constants_only
-            ? array_keys($this->valid_applies_to_options)
-            : $this->valid_applies_to_options;
-    }
+	public const APPLIES_TO_ALL         = 'all';
+
+	public const APPLIES_TO_PRIMARY     = 'primary';
+
+	public const APPLIES_TO_PURCHASER   = 'purchaser';
+
+	public const APPLIES_TO_REGISTRANTS = 'registrants';
+
+	/**
+	 * @var EEM_Form_Section
+	 */
+	protected static $_instance;
+
+	/**
+	 * @var RequestInterface
+	 */
+	private $request;
+
+	/**
+	 * @var array
+	 */
+	private $valid_applies_to_options;
+
+
+	/**
+	 * EEM_Form_Section constructor.
+	 *
+	 * @param FormStatus  $form_status
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(FormStatus $form_status, ?string $timezone)
+	{
+		$this->valid_applies_to_options = apply_filters(
+			'FHEE__EEM_Form_Section__valid_applies_to_options',
+			[
+				EEM_Form_Section::APPLIES_TO_ALL         => esc_html__('All Registrants', 'event_espresso'),
+				EEM_Form_Section::APPLIES_TO_PRIMARY     => esc_html__('Primary Registrant Only', 'event_espresso'),
+				EEM_Form_Section::APPLIES_TO_PURCHASER   => esc_html__('Purchasing Agent', 'event_espresso'),
+				EEM_Form_Section::APPLIES_TO_REGISTRANTS => esc_html__('Additional Registrants', 'event_espresso'),
+			]
+		);
+
+		$this->singular_item = esc_html__('Form Section', 'event_espresso');
+		$this->plural_item   = esc_html__('Form Sections', 'event_espresso');
+
+		$this->_tables          = [
+			'Form_Section' => new EE_Primary_Table('esp_form_section', 'FSC_UUID'),
+		];
+		$this->_fields          = [
+			'Form_Section' => [
+				'FSC_UUID'      => new EE_Primary_Key_String_Field(
+					'FSC_UUID',
+					esc_html__('Form Section UUID (universally unique identifier)', 'event_espresso')
+				),
+				'FSC_appliesTo' => new EE_Enum_Text_Field(
+					'FSC_appliesTo',
+					esc_html(
+						sprintf(
+							/* translators: 1 class name */
+							__(
+								'Form user type that this form section should be presented to. Values correspond to the %s constants.',
+								'event_espresso'
+							),
+							'EEM_Form_Section::APPLIES_TO_*'
+						)
+					),
+					false,
+					EEM_Form_Section::APPLIES_TO_ALL,
+					$this->valid_applies_to_options
+				),
+				'FSC_attributes' => new EE_JSON_Field(
+					'FSC_attributes',
+					esc_html__(
+						'JSON string of HTML attributes, such as class, to be applied to this form section\'s container.',
+						'event_espresso'
+					),
+					true,
+					'{}'
+				),
+				'FSC_belongsTo' => new EE_Plain_Text_Field(
+					'FSC_belongsTo',
+					esc_html__('UUID of parent form section that this one belongs to.', 'event_espresso'),
+					true,
+					null
+				),
+				'FSC_label' => new EE_JSON_Field(
+					'FSC_label',
+					esc_html__(
+						'JSON string of properties pertaining to a form section\'s label.',
+						'event_espresso'
+					),
+					true,
+					'{}'
+				),
+				'FSC_order'     => new EE_Integer_Field(
+					'FSC_order',
+					esc_html__('Order in which form section appears in a form.', 'event_espresso'),
+					false,
+					0
+				),
+				'FSC_status'    => new EE_Enum_Text_Field(
+					'FSC_status',
+					esc_html(
+						sprintf(
+							/* translators: 1 class name */
+							__(
+								'Whether form section is active, archived, shared, trashed, or used as a default on new forms. Values correspond to the %1$s class constants.',
+								'event_espresso'
+							),
+							'EventEspresso\core\services\form\meta\FormStatus'
+						)
+					),
+					false,
+					FormStatus::ACTIVE,
+					$form_status->validStatusOptions()
+				),
+				'FSC_wpUser'    => new EE_WP_User_Field(
+					'FSC_wpUser',
+					esc_html__('ID of the WP User that created this form section.', 'event_espresso'),
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Form_Element' => new EE_Has_Many_Relation(),
+			'Form_Submission' => new EE_Has_Many_Relation(),
+			'WP_User'    => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$restrictions                              = [];
+		$restrictions[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Public();
+		$restrictions[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
+		$restrictions[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
+		$restrictions[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
+		$this->_cap_restriction_generators         = $restrictions;
+		parent::__construct($timezone);
+		$this->request = $this->getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return array
+	 */
+	private function addDefaultWhereConditions(array $query_params): array
+	{
+		// might need to add a way to identify GQL requests for admin domains
+		$admin_request                            = $this->request->isAdmin() || $this->request->isAdminAjax();
+		$query_params['default_where_conditions'] = $admin_request
+			? EEM_Base::default_where_conditions_none
+			: EEM_Base::default_where_conditions_all;
+		return $query_params;
+	}
+
+
+	/**
+	 * form sections should always be sorted in ascending order via the FSC_order field
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	private function addOrderByQueryParams(array $query_params): array
+	{
+		$query_params['order_by'] = ['FSC_order' => 'ASC'];
+		return $query_params;
+	}
+
+
+	/**
+	 * returns an array of Form Sections for the specified parent Form Section
+	 *
+	 * @param string $FSC_UUID
+	 * @return EE_Form_Section[]
+	 * @throws EE_Error
+	 */
+	public function getChildFormSections(string $FSC_UUID): array
+	{
+		return $this->getFormSections(['FSC_belongsTo' => $FSC_UUID]);
+	}
+
+
+	/**
+	 * @return EE_Form_Section[]
+	 * @throws EE_Error
+	 */
+	public function getFormSections(array $where_params): array
+	{
+		$query_params = $this->addDefaultWhereConditions([$where_params]);
+		$query_params = $this->addOrderByQueryParams($query_params);
+		return $this->get_all($query_params);
+	}
+
+
+	/**
+	 * returns an array of Form Sections for the specified Event
+	 *
+	 * @param EE_Event $event
+	 * @return EE_Form_Section[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getFormSectionsForEvent(EE_Event $event): array
+	{
+		$FSC_UUID = $event->registrationFormUuid();
+		return ! empty($FSC_UUID)
+			? $this->getFormSections(
+				[
+					'OR' => [
+						'FSC_UUID'      => $FSC_UUID, // top level form
+						'FSC_belongsTo' => $FSC_UUID, // child form sections
+					]
+				]
+			)
+			: [];
+	}
+
+
+	/**
+	 * @param bool $constants_only
+	 * @return array
+	 */
+	public function validAppliesToOptions(bool $constants_only = false): array
+	{
+		return $constants_only
+			? array_keys($this->valid_applies_to_options)
+			: $this->valid_applies_to_options;
+	}
 }

core/db_classes/EE_Form_Section.class.php

Spacing +5 added lines, -5 removed lines

@@ -160,7 +160,7 @@ 
      */
     public function attributes(): ?Attributes
     {
-        if (! $this->attributes instanceof Attributes) {
+        if ( ! $this->attributes instanceof Attributes) {
             $this->attributes = Attributes::fromJson($this->get('FSC_attributes'));
         }
         return $this->attributes;
@@ -226,7 +226,7 @@ 
         $form_elements = $this->get_many_related('Form_Element', ['order_by' => ['FIN_order' => 'ASC']]);
         foreach ($form_elements as $form_element) {
             if ($form_element instanceof EE_Form_Element) {
-                $this->form_elements[ $form_element->UUID() ] = $form_element;
+                $this->form_elements[$form_element->UUID()] = $form_element;
             }
         }
         return $this->form_elements;
@@ -242,7 +242,7 @@ 
     {
         foreach ($form_elements as $form_element) {
             if ($form_element instanceof EE_Form_Element) {
-                $this->form_elements[ $form_element->UUID() ] = $form_element;
+                $this->form_elements[$form_element->UUID()] = $form_element;
             }
         }
     }
@@ -273,7 +273,7 @@ 
     public function formElementFilter(): Closure
     {
         $FSC_UUID = strtolower($this->UUID());
-        return function ($form_element) use ($FSC_UUID) {
+        return function($form_element) use ($FSC_UUID) {
             return $form_element instanceof EE_Form_Element && strtolower($form_element->belongsTo()) === $FSC_UUID;
         };
     }
@@ -288,7 +288,7 @@ 
      */
     public function label(): ?FormLabel
     {
-        if (! $this->label instanceof FormLabel) {
+        if ( ! $this->label instanceof FormLabel) {
             $this->label = FormLabel::fromJson($this->get('FSC_label'));
         }
         return $this->label;

Indentation +465 added lines, -465 removed lines

@@ -23,469 +23,469 @@
 class EE_Form_Section extends EE_Base_Class
 {
 
-    /**
-     * @var Attributes
-     */
-    private $attributes;
-
-    /**
-     * @var EE_Form_Element[]
-     */
-    private $form_elements = [];
-
-    /**
-     * @var FormLabel
-     */
-    private $label;
-
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Form_Section
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance(array $props_n_values = []): EE_Form_Section
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ?: new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Form_Section
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db(array $props_n_values = []): EE_Form_Section
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Form Section UUID (universally unique identifier)
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function UUID(): string
-    {
-        return $this->get('FSC_UUID');
-    }
-
-
-    /**
-     * last 8 characters of the UUID
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function uuidSlug(): string
-    {
-        return substr($this->UUID(), -8);
-    }
-
-
-    /**
-     * @param string $UUID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setUUID(string $UUID)
-    {
-        $this->set('FSC_UUID', $UUID);
-    }
-
-
-    /**
-     * Form user types that this form section should be presented to.
-     * Values correspond to the EEM_Form_Section::APPLIES_TO_* constants.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function appliesTo(): string
-    {
-        return $this->get('FSC_appliesTo');
-    }
-
-
-    /**
-     * Form user types that this form section should be presented to.
-     * Values correspond to the EEM_Form_Section::APPLIES_TO_* constants.
-     *
-     * @param EE_Registration|string $registrant
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function appliesToRegistrant($registrant): bool
-    {
-        switch ($this->appliesTo()) {
-            case EEM_Form_Section::APPLIES_TO_PRIMARY:
-                return $registrant instanceof EE_Registration && $registrant->is_primary_registrant();
-            case EEM_Form_Section::APPLIES_TO_PURCHASER:
-                return $registrant === 'purchaser';
-            case EEM_Form_Section::APPLIES_TO_REGISTRANTS:
-                return $registrant instanceof EE_Registration && ! $registrant->is_primary_registrant();
-            case EEM_Form_Section::APPLIES_TO_ALL:
-            default:
-                return true;
-        }
-    }
-
-
-    /**
-     * @param string $user_type
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setAppliesTo(string $user_type)
-    {
-        $this->set('FSC_appliesTo', $user_type);
-    }
-
-
-    /**
-     * JSON string of HTML attributes, such as class, to be applied to this form section\'s container.
-     *
-     * @return Attributes
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function attributes(): ?Attributes
-    {
-        if (! $this->attributes instanceof Attributes) {
-            $this->attributes = Attributes::fromJson($this->get('FSC_attributes'));
-        }
-        return $this->attributes;
-    }
-
-
-    /**
-     * @param Attributes $attributes
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setAttributes(Attributes $attributes)
-    {
-        // set local object
-        $this->attributes = $attributes;
-        // then pass to model as an array which will get converted to JSON by the model field
-        $this->set('FSC_attributes', $attributes->toArray());
-    }
-
-
-    /**
-     * UUID or ID of related entity this form section belongs to.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function belongsTo(): ?string
-    {
-        return $this->get('FSC_belongsTo');
-    }
-
-
-    /**
-     * @param string $parent_UUID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setBelongsTo(string $parent_UUID)
-    {
-        $this->set('FSC_belongsTo', $parent_UUID);
-    }
-
-
-    /**
-     * @return EE_Form_Element[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function formElements(): array
-    {
-        return $this->form_elements ?: $this->getFormElements();
-    }
-
-
-    /**
-     * @return EE_Form_Element[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function getFormElements(): array
-    {
-        $form_elements = $this->get_many_related('Form_Element', ['order_by' => ['FIN_order' => 'ASC']]);
-        foreach ($form_elements as $form_element) {
-            if ($form_element instanceof EE_Form_Element) {
-                $this->form_elements[ $form_element->UUID() ] = $form_element;
-            }
-        }
-        return $this->form_elements;
-    }
-
-
-    /**
-     * @param EE_Form_Element[] $form_elements
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setFormElements(array $form_elements): void
-    {
-        foreach ($form_elements as $form_element) {
-            if ($form_element instanceof EE_Form_Element) {
-                $this->form_elements[ $form_element->UUID() ] = $form_element;
-            }
-        }
-    }
-
-
-    /**
-     * @param EE_Form_Element[] $all_form_elements
-     * @return EE_Form_Element[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function filterFormElements(array $all_form_elements): array
-    {
-        return array_filter($all_form_elements, $this->formElementFilter());
-    }
-
-
-    /**
-     * returns a closure that can be used to filter form elements for this form section
-     * usage:
-     *  $filter = EEM_Form_Element::formElementFilter();
-     *  $filtered_form_elements = array_filter( $all_form_elements, $filter );
-     *
-     * @return Closure
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function formElementFilter(): Closure
-    {
-        $FSC_UUID = strtolower($this->UUID());
-        return function ($form_element) use ($FSC_UUID) {
-            return $form_element instanceof EE_Form_Element && strtolower($form_element->belongsTo()) === $FSC_UUID;
-        };
-    }
-
-
-    /**
-     * returns a FormLabel object for managing form section labels, ie: the form section heading
-     *
-     * @return FormLabel
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function label(): ?FormLabel
-    {
-        if (! $this->label instanceof FormLabel) {
-            $this->label = FormLabel::fromJson($this->get('FSC_label'));
-        }
-        return $this->label;
-    }
-
-
-    /**
-     * @param FormLabel $label
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setLabel(FormLabel $label)
-    {
-        // set local object
-        $this->label = $label;
-        // then pass to model as an array which will get converted to JSON by the model field
-        $this->set('FSC_label', $label->toJson());
-    }
-
-
-    /**
-     * Order in which form section appears in a form.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function order(): int
-    {
-        return $this->get('FSC_order');
-    }
-
-
-    /**
-     * @param int $order
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setOrder(int $order)
-    {
-        $this->set('FSC_order', $order);
-    }
-
-
-    /**
-     * combination of public label and UUID slug for use in identifiers
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function slug(): ?string
-    {
-        $label = sanitize_title($this->label()->publicLabel());
-        return "{$label}-{$this->uuidSlug()}";
-    }
-
-
-    /**
-     * Whether form section is active, archived, trashed, or used as a default on new forms.
-     * Values correspond to the EEM_Form_Section::STATUS_* constants.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function status(): ?string
-    {
-        return $this->get('FSC_status');
-    }
-
-
-    /**
-     * Whether form section is active, archived, trashed, or used as a default on new forms.
-     * Values correspond to the EEM_Form_Section::STATUS_* constants.
-     *
-     * @param string $status
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setStatus(string $status)
-    {
-        $this->set('FSC_status', $status);
-    }
-
-
-    /**
-     * returns the id the wordpress user who created this question
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function wp_user(): int
-    {
-        return $this->get('FSC_wpUser');
-    }
-
-
-    /**
-     * @param int $wp_user
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setWpUser(int $wp_user)
-    {
-        $this->set('FSC_wpUser', $wp_user);
-    }
-
-
-    /**
-     * @param array $set_cols_n_values
-     * @return bool|int|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function save($set_cols_n_values = [])
-    {
-        // make sure internal versions for all composite objects are updated
-        $this->set('FSC_attributes', $this->attributes()->toArray());
-        $this->set('FSC_label', $this->label()->toArray());
-        return parent::save($set_cols_n_values);
-    }
-
-    /**
-     * Whether the section is active.
-     *
-     * @return boolean  TRUE if is active, FALSE if not.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function isActive()
-    {
-        return $this->status() === FormStatus::ACTIVE;
-    }
-
-    /**
-     * Whether the section is archived.
-     *
-     * @return boolean  TRUE if is archived, FALSE if not.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function isArchived()
-    {
-        return $this->status() === FormStatus::ARCHIVED;
-    }
-
-    /**
-     * Whether the section is a default one.
-     *
-     * @return boolean  TRUE if is default, FALSE if not.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function isDefault()
-    {
-        return $this->status() === FormStatus::DEFAULT;
-    }
-
-    /**
-     * Whether the section is a shared one.
-     *
-     * @return boolean  TRUE if is shared, FALSE if not.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function isShared()
-    {
-        return $this->status() === FormStatus::SHARED;
-    }
-
-    /**
-     * Whether the section is trashed.
-     *
-     * @return boolean  TRUE if is trashed, FALSE if not.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function isTrashed()
-    {
-        return $this->status() === FormStatus::TRASHED;
-    }
+	/**
+	 * @var Attributes
+	 */
+	private $attributes;
+
+	/**
+	 * @var EE_Form_Element[]
+	 */
+	private $form_elements = [];
+
+	/**
+	 * @var FormLabel
+	 */
+	private $label;
+
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Form_Section
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance(array $props_n_values = []): EE_Form_Section
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ?: new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Form_Section
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db(array $props_n_values = []): EE_Form_Section
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Form Section UUID (universally unique identifier)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function UUID(): string
+	{
+		return $this->get('FSC_UUID');
+	}
+
+
+	/**
+	 * last 8 characters of the UUID
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function uuidSlug(): string
+	{
+		return substr($this->UUID(), -8);
+	}
+
+
+	/**
+	 * @param string $UUID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setUUID(string $UUID)
+	{
+		$this->set('FSC_UUID', $UUID);
+	}
+
+
+	/**
+	 * Form user types that this form section should be presented to.
+	 * Values correspond to the EEM_Form_Section::APPLIES_TO_* constants.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function appliesTo(): string
+	{
+		return $this->get('FSC_appliesTo');
+	}
+
+
+	/**
+	 * Form user types that this form section should be presented to.
+	 * Values correspond to the EEM_Form_Section::APPLIES_TO_* constants.
+	 *
+	 * @param EE_Registration|string $registrant
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function appliesToRegistrant($registrant): bool
+	{
+		switch ($this->appliesTo()) {
+			case EEM_Form_Section::APPLIES_TO_PRIMARY:
+				return $registrant instanceof EE_Registration && $registrant->is_primary_registrant();
+			case EEM_Form_Section::APPLIES_TO_PURCHASER:
+				return $registrant === 'purchaser';
+			case EEM_Form_Section::APPLIES_TO_REGISTRANTS:
+				return $registrant instanceof EE_Registration && ! $registrant->is_primary_registrant();
+			case EEM_Form_Section::APPLIES_TO_ALL:
+			default:
+				return true;
+		}
+	}
+
+
+	/**
+	 * @param string $user_type
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setAppliesTo(string $user_type)
+	{
+		$this->set('FSC_appliesTo', $user_type);
+	}
+
+
+	/**
+	 * JSON string of HTML attributes, such as class, to be applied to this form section\'s container.
+	 *
+	 * @return Attributes
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function attributes(): ?Attributes
+	{
+		if (! $this->attributes instanceof Attributes) {
+			$this->attributes = Attributes::fromJson($this->get('FSC_attributes'));
+		}
+		return $this->attributes;
+	}
+
+
+	/**
+	 * @param Attributes $attributes
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setAttributes(Attributes $attributes)
+	{
+		// set local object
+		$this->attributes = $attributes;
+		// then pass to model as an array which will get converted to JSON by the model field
+		$this->set('FSC_attributes', $attributes->toArray());
+	}
+
+
+	/**
+	 * UUID or ID of related entity this form section belongs to.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function belongsTo(): ?string
+	{
+		return $this->get('FSC_belongsTo');
+	}
+
+
+	/**
+	 * @param string $parent_UUID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setBelongsTo(string $parent_UUID)
+	{
+		$this->set('FSC_belongsTo', $parent_UUID);
+	}
+
+
+	/**
+	 * @return EE_Form_Element[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function formElements(): array
+	{
+		return $this->form_elements ?: $this->getFormElements();
+	}
+
+
+	/**
+	 * @return EE_Form_Element[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function getFormElements(): array
+	{
+		$form_elements = $this->get_many_related('Form_Element', ['order_by' => ['FIN_order' => 'ASC']]);
+		foreach ($form_elements as $form_element) {
+			if ($form_element instanceof EE_Form_Element) {
+				$this->form_elements[ $form_element->UUID() ] = $form_element;
+			}
+		}
+		return $this->form_elements;
+	}
+
+
+	/**
+	 * @param EE_Form_Element[] $form_elements
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setFormElements(array $form_elements): void
+	{
+		foreach ($form_elements as $form_element) {
+			if ($form_element instanceof EE_Form_Element) {
+				$this->form_elements[ $form_element->UUID() ] = $form_element;
+			}
+		}
+	}
+
+
+	/**
+	 * @param EE_Form_Element[] $all_form_elements
+	 * @return EE_Form_Element[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function filterFormElements(array $all_form_elements): array
+	{
+		return array_filter($all_form_elements, $this->formElementFilter());
+	}
+
+
+	/**
+	 * returns a closure that can be used to filter form elements for this form section
+	 * usage:
+	 *  $filter = EEM_Form_Element::formElementFilter();
+	 *  $filtered_form_elements = array_filter( $all_form_elements, $filter );
+	 *
+	 * @return Closure
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function formElementFilter(): Closure
+	{
+		$FSC_UUID = strtolower($this->UUID());
+		return function ($form_element) use ($FSC_UUID) {
+			return $form_element instanceof EE_Form_Element && strtolower($form_element->belongsTo()) === $FSC_UUID;
+		};
+	}
+
+
+	/**
+	 * returns a FormLabel object for managing form section labels, ie: the form section heading
+	 *
+	 * @return FormLabel
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function label(): ?FormLabel
+	{
+		if (! $this->label instanceof FormLabel) {
+			$this->label = FormLabel::fromJson($this->get('FSC_label'));
+		}
+		return $this->label;
+	}
+
+
+	/**
+	 * @param FormLabel $label
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setLabel(FormLabel $label)
+	{
+		// set local object
+		$this->label = $label;
+		// then pass to model as an array which will get converted to JSON by the model field
+		$this->set('FSC_label', $label->toJson());
+	}
+
+
+	/**
+	 * Order in which form section appears in a form.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function order(): int
+	{
+		return $this->get('FSC_order');
+	}
+
+
+	/**
+	 * @param int $order
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setOrder(int $order)
+	{
+		$this->set('FSC_order', $order);
+	}
+
+
+	/**
+	 * combination of public label and UUID slug for use in identifiers
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function slug(): ?string
+	{
+		$label = sanitize_title($this->label()->publicLabel());
+		return "{$label}-{$this->uuidSlug()}";
+	}
+
+
+	/**
+	 * Whether form section is active, archived, trashed, or used as a default on new forms.
+	 * Values correspond to the EEM_Form_Section::STATUS_* constants.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function status(): ?string
+	{
+		return $this->get('FSC_status');
+	}
+
+
+	/**
+	 * Whether form section is active, archived, trashed, or used as a default on new forms.
+	 * Values correspond to the EEM_Form_Section::STATUS_* constants.
+	 *
+	 * @param string $status
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setStatus(string $status)
+	{
+		$this->set('FSC_status', $status);
+	}
+
+
+	/**
+	 * returns the id the wordpress user who created this question
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function wp_user(): int
+	{
+		return $this->get('FSC_wpUser');
+	}
+
+
+	/**
+	 * @param int $wp_user
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setWpUser(int $wp_user)
+	{
+		$this->set('FSC_wpUser', $wp_user);
+	}
+
+
+	/**
+	 * @param array $set_cols_n_values
+	 * @return bool|int|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function save($set_cols_n_values = [])
+	{
+		// make sure internal versions for all composite objects are updated
+		$this->set('FSC_attributes', $this->attributes()->toArray());
+		$this->set('FSC_label', $this->label()->toArray());
+		return parent::save($set_cols_n_values);
+	}
+
+	/**
+	 * Whether the section is active.
+	 *
+	 * @return boolean  TRUE if is active, FALSE if not.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function isActive()
+	{
+		return $this->status() === FormStatus::ACTIVE;
+	}
+
+	/**
+	 * Whether the section is archived.
+	 *
+	 * @return boolean  TRUE if is archived, FALSE if not.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function isArchived()
+	{
+		return $this->status() === FormStatus::ARCHIVED;
+	}
+
+	/**
+	 * Whether the section is a default one.
+	 *
+	 * @return boolean  TRUE if is default, FALSE if not.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function isDefault()
+	{
+		return $this->status() === FormStatus::DEFAULT;
+	}
+
+	/**
+	 * Whether the section is a shared one.
+	 *
+	 * @return boolean  TRUE if is shared, FALSE if not.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function isShared()
+	{
+		return $this->status() === FormStatus::SHARED;
+	}
+
+	/**
+	 * Whether the section is trashed.
+	 *
+	 * @return boolean  TRUE if is trashed, FALSE if not.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function isTrashed()
+	{
+		return $this->status() === FormStatus::TRASHED;
+	}
 }