class BinaryData

Same name in other branches
  1. 9 core/lib/Drupal/Core/TypedData/Plugin/DataType/BinaryData.php \Drupal\Core\TypedData\Plugin\DataType\BinaryData
  2. 8.9.x core/lib/Drupal/Core/TypedData/Plugin/DataType/BinaryData.php \Drupal\Core\TypedData\Plugin\DataType\BinaryData
  3. 11.x 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 an (absolute) stream resource URI may be passed.

Hierarchy

  • class \Drupal\Core\TypedData\Plugin\DataType\BinaryData extends \Drupal\Core\TypedData\PrimitiveBase implements \Drupal\Core\TypedData\Type\BinaryInterface

Expanded class hierarchy of BinaryData

File

core/lib/Drupal/Core/TypedData/Plugin/DataType/BinaryData.php, line 17

Namespace

Drupal\Core\TypedData\Plugin\DataType
View 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 an (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

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
BinaryData::$handle public property A generic file resource handle.
BinaryData::$uri protected property The file resource URI.
BinaryData::getCastedValue public function Overrides PrimitiveInterface::getCastedValue
BinaryData::getString public function Overrides TypedData::getString
BinaryData::getValue public function Overrides PrimitiveBase::getValue
BinaryData::setValue public function Overrides TypedData::setValue(). Overrides PrimitiveBase::setValue
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
PrimitiveBase::$value protected property The data value. 1
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TypedData::$definition protected property The data definition. 1
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::applyDefaultValue public function Overrides TypedDataInterface::applyDefaultValue 3
TypedData::createInstance public static function Overrides TypedDataInterface::createInstance
TypedData::getConstraints public function Overrides TypedDataInterface::getConstraints 8
TypedData::getDataDefinition public function Overrides TypedDataInterface::getDataDefinition
TypedData::getName public function Overrides TypedDataInterface::getName
TypedData::getParent public function Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition public function Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId public function Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath public function Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot public function Overrides TypedDataInterface::getRoot
TypedData::setContext public function Overrides TypedDataInterface::setContext
TypedData::validate public function Overrides TypedDataInterface::validate
TypedData::__construct public function Constructs a TypedData object given its definition and context. 4
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.