BearFramework\App\IDataDriver

A data driver interface.


BearFramework\App\IDataDriver {

    /* Methods */
    abstract public void append ( string $key , string $content )
    abstract public void delete ( string $key )
    abstract public void deleteMetadata ( string $key , string $name )
    abstract public void duplicate ( string $sourceKey , string $destinationKey )
    abstract public bool exists ( string $key )
    abstract public BearFramework\App\DataItem|null get ( string $key )
    abstract public BearFramework\App\IDataItemStreamWrapper getDataItemStreamWrapper ( string $key )
    abstract public BearFramework\DataList|BearFramework\App\DataItem[] getList ( [ BearFramework\DataList\Context|null $context ] )
    abstract public string|null getMetadata ( string $key , string $name )
    abstract public string|null getValue ( string $key )
    abstract public void rename ( string $sourceKey , string $destinationKey )
    abstract public void set ( BearFramework\App\DataItem $item )
    abstract public void setMetadata ( string $key , string $name , string $value )
    abstract public void setValue ( string $key , string $value )

}

Methods

abstract public void append ( string $key , string $content )

Appends data to the data item's value specified. If the data item does not exist, it will be created.

abstract public void delete ( string $key )

Deletes the data item specified and it's metadata.

abstract public void deleteMetadata ( string $key , string $name )

Deletes metadata for the data item key specified.

abstract public void duplicate ( string $sourceKey , string $destinationKey )

Creates a copy of the data item specified.

abstract public bool exists ( string $key )

Returns TRUE if the data item exists. FALSE otherwise.

abstract public BearFramework\App\DataItem|null get ( string $key )

Returns a stored data item or null if not found.

abstract public BearFramework\App\IDataItemStreamWrapper getDataItemStreamWrapper ( string $key )

Returns a DataItemStreamWrapper for the key specified.

abstract public BearFramework\DataList|BearFramework\App\DataItem[] getList ( [ BearFramework\DataList\Context|null $context ] )

Returns a list of all items in the data storage.

abstract public string|null getMetadata ( string $key , string $name )

Retrieves metadata for the data item specified.

abstract public string|null getValue ( string $key )

Returns the value of a stored data item or null if not found.

abstract public void rename ( string $sourceKey , string $destinationKey )

Changes the key of the data item specified.

abstract public void set ( BearFramework\App\DataItem $item )

Stores a data item.

abstract public void setMetadata ( string $key , string $name , string $value )

Stores metadata for the data item specified.

abstract public void setValue ( string $key , string $value )

Sets a new value of the item specified or creates a new item with the key and value specified.

Details

Location: ~/src/App/FileDataDriver.php

back to index

The information on this page is created for version 1.1 of Bear Framework and may not be applicable for other versions of the framework.