Chris@17: <?php
Chris@17: 
Chris@17: /*
Chris@17:  * This file is a part of dflydev/dot-access-data.
Chris@17:  *
Chris@17:  * (c) Dragonfly Development Inc.
Chris@17:  *
Chris@17:  * For the full copyright and license information, please view the LICENSE
Chris@17:  * file that was distributed with this source code.
Chris@17:  */
Chris@17: 
Chris@17: namespace Dflydev\DotAccessData;
Chris@17: 
Chris@17: interface DataInterface
Chris@17: {
Chris@17:     /**
Chris@17:      * Append a value to a key (assumes key refers to an array value)
Chris@17:      *
Chris@17:      * @param string $key
Chris@17:      * @param mixed  $value
Chris@17:      */
Chris@17:     public function append($key, $value = null);
Chris@17: 
Chris@17:     /**
Chris@17:      * Set a value for a key
Chris@17:      *
Chris@17:      * @param string $key
Chris@17:      * @param mixed  $value
Chris@17:      */
Chris@17:     public function set($key, $value = null);
Chris@17: 
Chris@17:     /**
Chris@17:      * Remove a key
Chris@17:      *
Chris@17:      * @param string $key
Chris@17:      */
Chris@17:     public function remove($key);
Chris@17: 
Chris@17:     /**
Chris@17:      * Get the raw value for a key
Chris@17:      *
Chris@17:      * @param string $key
Chris@17:      * @param mixed $default
Chris@17:      *
Chris@17:      * @return mixed
Chris@17:      */
Chris@17:     public function get($key, $default = null);
Chris@17: 
Chris@17:     /**
Chris@17:      * Check if the key exists
Chris@17:      *
Chris@17:      * @param string $key
Chris@17:      *
Chris@17:      * @return bool
Chris@17:      */
Chris@17:     public function has($key);
Chris@17: 
Chris@17:     /**
Chris@17:      * Get a data instance for a key
Chris@17:      *
Chris@17:      * @param string $key
Chris@17:      *
Chris@17:      * @return DataInterface
Chris@17:      */
Chris@17:     public function getData($key);
Chris@17: 
Chris@17:     /**
Chris@17:      * Import data into existing data
Chris@17:      *
Chris@17:      * @param array $data
Chris@17:      * @param bool  $clobber
Chris@17:      */
Chris@17:     public function import(array $data, $clobber = true);
Chris@17: 
Chris@17:     /**
Chris@17:      * Import data from an external data into existing data
Chris@17:      *
Chris@17:      * @param DataInterface $data
Chris@17:      * @param bool          $clobber
Chris@17:      */
Chris@17:     public function importData(DataInterface $data, $clobber = true);
Chris@17: 
Chris@17:     /**
Chris@17:      * Export data as raw data
Chris@17:      *
Chris@17:      * @return array
Chris@17:      */
Chris@17:     public function export();
Chris@17: }