Code Coverage for /var/lib/jenkins/workspace/cscfa_tool_division/collections/src/CSDT/CollectionsBundle/CollectionInterfaces/ValueCollectionInterface.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

1	<?php
2	/**
3	* This file is part of the Hephaistos project management API.
4	*
5	* As each files provides by the CSCFA, this file is licensed
6	* under the MIT license.
7	*
8	* PHP version 5.6
9	*
10	* @category Interface
11	* @package Hephaistos
12	* @author matthieu vallance <matthieu.vallance@cscfa.fr>
13	* @license MIT <https://opensource.org/licenses/MIT>
14	* @link http://cscfa.fr
15	*/
16	namespace CSDT\CollectionsBundle\CollectionInterfaces;
17
18	use CSDT\CollectionsBundle\CollectionInterfaces\CollectionInterface;
19
20	/**
21	* Value collection interface
22	*
23	* This interface define the base methods of a simple value
24	* collection.
25	*
26	* @category Interface
27	* @package Hephaistos
28	* @author matthieu vallance <matthieu.vallance@cscfa.fr>
29	* @license MIT <https://opensource.org/licenses/MIT>
30	* @link http://cscfa.fr
31	*/
32	interface ValueCollectionInterface extends CollectionInterface
33	{
34	/**
35	* Add
36	*
37	* This method is used to add a new
38	* element to the collection.
39	*
40	* @param mixed $value The value to add
41	*
42	* @return ValueCollectionInterface
43	*/
44	public function add($value);
45
46	/**
47	* Add all
48	*
49	* This method is used to add a list
50	* of new element to the collection.
51	*
52	* @param array $values The value list to add
53	*
54	* @return ValueCollectionInterface
55	*/
56	public function addAll(array $values);
57
58	/**
59	* Remove
60	*
61	* This method is used to remove an
62	* element from the collection. It
63	* return the removed element or null
64	* if no one is removed.
65	*
66	* @param mixed $value The value to remove
67	*
68	* @return mixed\|null
69	*/
70	public function remove($value);
71
72	/**
73	* Remove all
74	*
75	* This method is used to remove a list
76	* of element from the collection. It
77	* return a list of removed elements.
78	*
79	* @param array $values The list of value to remove
80	*
81	* @return array
82	*/
83	public function removeAll(array $values);
84	}