class BinaryData in Drupal 8
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/TypedData/Plugin/DataType/BinaryData.php \Drupal\Core\TypedData\Plugin\DataType\BinaryData
- 10 core/lib/Drupal/Core/TypedData/Plugin/DataType/BinaryData.php \Drupal\Core\TypedData\Plugin\DataType\BinaryData
The binary data type.
The plain value of binary data is a PHP file resource, see http://php.net/manual/language.types.resource.php. For setting the value a PHP file resource or a (absolute) stream resource URI may be passed.
Plugin annotation
@DataType(
id = "binary",
label = @Translation("Binary")
)
Hierarchy
- class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\PrimitiveBase implements PrimitiveInterface
- class \Drupal\Core\TypedData\Plugin\DataType\BinaryData implements BinaryInterface
- class \Drupal\Core\TypedData\PrimitiveBase implements PrimitiveInterface
Expanded class hierarchy of BinaryData
File
- core/
lib/ Drupal/ Core/ TypedData/ Plugin/ DataType/ BinaryData.php, line 20
Namespace
Drupal\Core\TypedData\Plugin\DataTypeView source
class BinaryData extends PrimitiveBase implements BinaryInterface {
/**
* The file resource URI.
*
* @var string
*/
protected $uri;
/**
* A generic file resource handle.
*
* @var resource
*/
public $handle = NULL;
/**
* {@inheritdoc}
*/
public function getValue() {
// If the value has been set by (absolute) stream resource URI, access the
// resource now.
if (!isset($this->handle) && isset($this->uri)) {
$this->handle = is_readable($this->uri) ? fopen($this->uri, 'rb') : FALSE;
}
return $this->handle;
}
/**
* Overrides TypedData::setValue().
*
* Supports a PHP file resource or a (absolute) stream resource URI as value.
*/
public function setValue($value, $notify = TRUE) {
if (!isset($value)) {
$this->handle = NULL;
$this->uri = NULL;
}
elseif (is_string($value)) {
// Note: For performance reasons we store the given URI and access the
// resource upon request. See BinaryData::getValue()
$this->uri = $value;
$this->handle = NULL;
}
else {
$this->handle = $value;
}
// Notify the parent of any changes.
if ($notify && isset($this->parent)) {
$this->parent
->onChange($this->name);
}
}
/**
* {@inheritdoc}
*/
public function getString() {
// Return the file content.
$contents = '';
while (!feof($this
->getValue())) {
$contents .= fread($this->handle, 8192);
}
return $contents;
}
/**
* {@inheritdoc}
*/
public function getCastedValue() {
return $this
->getValue();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BinaryData:: |
public | property | A generic file resource handle. | |
BinaryData:: |
protected | property | The file resource URI. | |
BinaryData:: |
public | function |
Gets the primitive data value casted to the correct PHP type. Overrides PrimitiveInterface:: |
|
BinaryData:: |
public | function |
Returns a string representation of the data. Overrides TypedData:: |
|
BinaryData:: |
public | function |
Gets the data value. Overrides PrimitiveBase:: |
|
BinaryData:: |
public | function |
Overrides TypedData::setValue(). Overrides PrimitiveBase:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
PrimitiveBase:: |
protected | property | The data value. | 1 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TypedData:: |
protected | property | The data definition. | 1 |
TypedData:: |
protected | property | The property name. | |
TypedData:: |
protected | property | The parent typed data object. | |
TypedData:: |
public | function |
Applies the default value. Overrides TypedDataInterface:: |
3 |
TypedData:: |
public static | function |
Constructs a TypedData object given its definition and context. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Gets a list of validation constraints. Overrides TypedDataInterface:: |
9 |
TypedData:: |
public | function |
Gets the data definition. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the name of a property or item. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
TypedData:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
TypedData:: |
public | function |
Returns the property path of the data. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the root of the typed data tree. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Validates the currently set data value. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function | Constructs a TypedData object given its definition and context. | 3 |
TypedDataTrait:: |
protected | property | The typed data manager used for creating the data types. | |
TypedDataTrait:: |
public | function | Gets the typed data manager. | 2 |
TypedDataTrait:: |
public | function | Sets the typed data manager. | 2 |