[TASK] Add a set of interfaces for collection
[Packages/TYPO3.CMS.git] / t3lib / collection / interfaces / interface.t3lib_collection_sortable.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2011 Steffen Ritter <typo3steffen-ritter.net>
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28
29 /**
30 * Interface for collection class being sortable
31 *
32 * This interface allows you to either define a callback implementing
33 * your own sorting method and explicitly move an item from one position
34 * to another.
35 *
36 * This assumes that entries are sortable and therefore a index can be assigned
37 *
38 * @author Steffen Ritter <typo3steffen-ritter.net>
39 * @package TYPO3
40 * @subpackage t3lib
41 */
42 interface t3lib_collection_Sortable {
43
44 /**
45 * Sorts collection via given callBackFunction
46 *
47 * The comparison function given as must return an integer less than, equal to, or greater than
48 * zero if the first argument is considered to be respectively less than, equal to, or greater than the second.
49 *
50 * @abstract
51 * @param $callbackFunction
52 * @see http://www.php.net/manual/en/function.usort.php
53 * @return void
54 */
55 public function usort($callbackFunction);
56
57 /**
58 * Moves the item within the collection
59 *
60 * The item at $currentPosition will be moved to
61 * $newPosition. Ommiting $newPosition will move to top.
62 *
63 * @abstract
64 * @param int $currentPosition
65 * @param int $newPosition
66 * @return void
67 */
68 public function moveItemAt($currentPosition, $newPosition = 0);
69 }
70
71 ?>