Interface FileContract

This constructor should accept three optional parameters, $file, $path, and $type. All three are optional.

The object MUST NOT automatically initialize unless $file is provided.

The object MUST NOT be considered functionally useable unless initialized.

The object MAY provide an internal mechanism for initialization that is protected.

If $file is passed, it MUST represent the string name of the fully qualified filepath, or a string name of a resource pointer that can be directly used to create a resource to the file.

If $type is supplied, it MUST represent either a file extension or mime type that corresponds to the file name. This value MUST only be used to identify the file type, and MUST NOT be used to build a path to the actual file, which prevents temp files that do not have extensions from accidentally not being identified on disk.

If $type is not supplied, it SHOULD be attempted to determine based on $file as an extension if it exists, and MUST default to binary if it cannot be determined to maximize portability.

If $temp_alias is supplied, the file MUST be renamed to this name if it is retained or moved from the temp directory to another location and no other name for it is provided. This only applies if it is actually a temp file, and otherwise this parameter has no effect, even if provided.

The object should interpret the file as a temp file if it's directory corresponds to the runtime value of: \oroboros\core\interfaces\enumerated\environment\CoreEnvironmentInterface::TEMP_DIRECTORY, which will determine the fully qualified location of the system temp directory at runtime if not overridden manually. This value will be false if it is not set or is not readable and writeable.

If any arguments cannot be determined, this method MUST throw a RuntimeException that implements \oroboros\core\interfaces\contract\utilities\exception\ExceptionContract either directly or indirectly.

Parameters