Class shardimage\shardimagephpapi\web\FileReference

All Classes | Properties | Methods
Inheritanceshardimage\shardimagephpapi\web\FileReference » shardimage\shardimagephpapi\base\BaseObject

File reference object.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$field string Referenced field shardimage\shardimagephpapi\web\FileReference
$file mixed File shardimage\shardimagephpapi\web\FileReference
$id string Referenced field ID (if array) shardimage\shardimagephpapi\web\FileReference

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Creates the object, populates the properties and calls the "init" method. shardimage\shardimagephpapi\base\BaseObject
__get() Returns the value of a non-defined property, it there is a getter method. shardimage\shardimagephpapi\base\BaseObject
__isset() Does the non-defined property with a getter exist and is it not NULL? shardimage\shardimagephpapi\base\BaseObject
__set() Sets the value of a non-defined property, if there is a setter method. shardimage\shardimagephpapi\base\BaseObject
__unset() Sets the value of a non-defined property to NULL, if there is a setter. shardimage\shardimagephpapi\base\BaseObject
createHeader() Creates a HTTP header from the reference. shardimage\shardimagephpapi\web\FileReference
fromHeader() Creates a reference from a HTTP header. shardimage\shardimagephpapi\web\FileReference
toArray() Converts the object an array. shardimage\shardimagephpapi\base\BaseObject

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
ensureClass() Creates an object from the given parameters. shardimage\shardimagephpapi\base\BaseObject
init() Custom initialization. shardimage\shardimagephpapi\base\BaseObject

Property Details

$field public property

Referenced field

public string $field = null
$file public property

File

public mixed $file = null
$id public property

Referenced field ID (if array)

public string $id = null

Method Details

createHeader() public method

Creates a HTTP header from the reference.

public string createHeader ( )
fromHeader() public static method

Creates a reference from a HTTP header.

public static \self fromHeader ( $header, $file )
$header string

Header in string
$file mixed