1. /var/lib/jenkins/workspace/cscfa_tool_division/collections/src/CSDT/CollectionsBundle
  2. CollectionInterfaces
  3. MapCollectionInterface.php
 
Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
100.00% covered (success)
0 / 0
100.00% covered (success)
100.00%
0 / 0
 CRAP
100.00% covered (success)
100.00%
0 / 0
<?php
/**
 * This file is part of the Hephaistos project management API.
 * 
 * As each files provides by the CSCFA, this file is licensed
 * under the MIT license.
 *
 * PHP version 5.6
 *
 * @category Interface
 * @package  Hephaistos
 * @author   matthieu vallance <matthieu.vallance@cscfa.fr>
 * @license  MIT <https://opensource.org/licenses/MIT>
 * @link     http://cscfa.fr
 */
namespace CSDT\CollectionsBundle\CollectionInterfaces;
use CSDT\CollectionsBundle\CollectionInterfaces\CollectionInterface;
/**
 * Map collection interface
 *
 * This interface define the base methods
 * for a mapped collection.
 *
 * @category Interface
 * @package  Hephaistos
 * @author   matthieu vallance <matthieu.vallance@cscfa.fr>
 * @license  MIT <https://opensource.org/licenses/MIT>
 * @link     http://cscfa.fr
 */
interface MapCollectionInterface extends CollectionInterface
{
    /**
     * Has
     * 
     * This method check if the given key exist
     * in the current content set. It return
     * true if the key is find. False otherwise.
     * 
     * @param mixed $key The key to search
     * 
     * @return boolean
     */
    public function has($key);
    
    /**
     * Get
     * 
     * This method is used to get the content of
     * the specified index if exist. It return
     * null if the index does not contain anything
     * or if it does not exist.
     * 
     * @param mixed $key The index whence get the content
     * 
     * @return mixed|null
     */
    public function get($key);
    
    /**
     * Set
     * 
     * This method set a specific key with a value.
     * 
     * @param mixed $key   The key where insert the value
     * @param mixed $value The value to insert
     * 
     * @return MapCollectionInterface
     */
    public function set($key, $value);
    
    /**
     * Set all
     * 
     * Setting a list of key value into an
     * associative array.
     * 
     * @param array $assocArray The associative array to insert
     * 
     * @return MapCollectionInterface
     */
    public function setAll(array $assocArray);
    
    /**
     * Remove
     * 
     * Remove a specified key. It return the
     * value contained into the key.
     * 
     * @param mixed $key The key to remove
     * 
     * @return mixed
     */
    public function remove($key);
    
    /**
     * Remove all
     * 
     * This method allow to remove a set of key. It return
     * an array of removed value.
     * 
     * @param array $keys The set of key to remove
     * 
     * @return array
     */
    public function removeAll(array $keys);
}