Skip to content

Commit f54bf7c

Browse files
committed
🎨 Normalize 'namespace' style.
1 parent 618bc5a commit f54bf7c

16 files changed

+2392
-2408
lines changed

src/Collections/Collection.php

+240-241
Large diffs are not rendered by default.

src/Collections/ICollection.php

+52-53
Original file line numberDiff line numberDiff line change
@@ -17,70 +17,69 @@
1717
* @license http://www.opensource.org/licenses/mit-license.php The MIT License (MIT)
1818
* */
1919

20-
namespace NelsonMartell\Collections {
20+
namespace NelsonMartell\Collections;
21+
22+
use \Iterator;
23+
24+
/**
25+
* Define métodos para manipular colecciones de objetos.
26+
*
27+
* @author Nelson Martell <nelson6e65@gmail.com>
28+
* */
29+
interface ICollection extends Iterator
30+
{
2131

22-
use \Iterator;
2332

2433
/**
25-
* Define métodos para manipular colecciones de objetos.
34+
* Obtiene el número de elementos incluidos en la colección.
35+
* Si extiende la clase NelsonMartell.Object, puede accederse desde la
36+
* propiedad `Count`.
2637
*
27-
* @author Nelson Martell <nelson6e65@gmail.com>
38+
* @return integer
39+
* @see NelsonMartell\Object
2840
* */
29-
interface ICollection extends Iterator
30-
{
31-
41+
public function getCount();
3242

33-
/**
34-
* Obtiene el número de elementos incluidos en la colección.
35-
* Si extiende la clase NelsonMartell.Object, puede accederse desde la
36-
* propiedad `Count`.
37-
*
38-
* @return integer
39-
* @see NelsonMartell\Object
40-
* */
41-
public function getCount();
4243

43-
44-
/**
45-
* Agrega un elemento a la colección.
46-
*
47-
* @param mixed $item Objeto que se va a agregar.
48-
*
49-
* @return void
50-
* */
51-
public function add($item);
44+
/**
45+
* Agrega un elemento a la colección.
46+
*
47+
* @param mixed $item Objeto que se va a agregar.
48+
*
49+
* @return void
50+
* */
51+
public function add($item);
5252

5353

54-
/**
55-
* Quita todos los elementos de la colección.
56-
* La propiedad Count se debe establecer en 0 y deben liberarse las
57-
* referencias a otros objetos desde los elementos de la colección.
58-
*
59-
* @return void
60-
* */
61-
public function clear();
54+
/**
55+
* Quita todos los elementos de la colección.
56+
* La propiedad Count se debe establecer en 0 y deben liberarse las
57+
* referencias a otros objetos desde los elementos de la colección.
58+
*
59+
* @return void
60+
* */
61+
public function clear();
6262

6363

64-
/**
65-
* Determina si la colección contiene al elemento especificado.
66-
*
67-
* @param mixed $item Objeto que se va a buscar.
68-
*
69-
* @return boolean `true` si $item se encuentra; en caso contrario, `false`.
70-
* */
71-
public function contains($item);
64+
/**
65+
* Determina si la colección contiene al elemento especificado.
66+
*
67+
* @param mixed $item Objeto que se va a buscar.
68+
*
69+
* @return boolean `true` si $item se encuentra; en caso contrario, `false`.
70+
* */
71+
public function contains($item);
7272

7373

74-
/**
75-
* Quita, si existe, la primera aparición de un objeto específico de la
76-
* colección.
77-
*
78-
* @param mixed $item Objeto que se va a quitar.
79-
*
80-
* @return boolean `true` si el elemento se ha quitado correctamente; en
81-
* caso contrario, `false`. Este método también devuelve `false` si no
82-
* se encontró.
83-
* */
84-
public function remove($item);
85-
}
74+
/**
75+
* Quita, si existe, la primera aparición de un objeto específico de la
76+
* colección.
77+
*
78+
* @param mixed $item Objeto que se va a quitar.
79+
*
80+
* @return boolean `true` si el elemento se ha quitado correctamente; en
81+
* caso contrario, `false`. Este método también devuelve `false` si no
82+
* se encontró.
83+
* */
84+
public function remove($item);
8685
}

src/Collections/IList.php

+40-41
Original file line numberDiff line numberDiff line change
@@ -17,53 +17,52 @@
1717
* @license http://www.opensource.org/licenses/mit-license.php The MIT License (MIT)
1818
* */
1919

20-
namespace NelsonMartell\Collections {
20+
namespace NelsonMartell\Collections;
21+
22+
/**
23+
* Representa una colección de objetos a los que se puede tener acceso por
24+
* un índice.
25+
*
26+
* @author Nelson Martell <nelson6e65@gmail.com>
27+
* */
28+
interface IList extends ICollection
29+
{
30+
2131

2232
/**
23-
* Representa una colección de objetos a los que se puede tener acceso por
24-
* un índice.
33+
* Determina el índice de un elemento específico de la lista.
34+
* Si un objeto aparece varias veces en la lista, el método indexOf
35+
* siempre devolverá la primera instancia encontrada.
36+
*
37+
* @param mixed $item Objeto que se va a buscar.
2538
*
26-
* @author Nelson Martell <nelson6e65@gmail.com>
39+
* @return integer Índice de $item si se encuentra en la lista; en caso
40+
* contrario, -1.
2741
* */
28-
interface IList extends ICollection
29-
{
30-
31-
32-
/**
33-
* Determina el índice de un elemento específico de la lista.
34-
* Si un objeto aparece varias veces en la lista, el método indexOf
35-
* siempre devolverá la primera instancia encontrada.
36-
*
37-
* @param mixed $item Objeto que se va a buscar.
38-
*
39-
* @return integer Índice de $item si se encuentra en la lista; en caso
40-
* contrario, -1.
41-
* */
42-
public function indexOf($item);
42+
public function indexOf($item);
4343

4444

45-
/**
46-
* Inserta un elemento en la lista, en el índice especificado.
47-
*
48-
* @param integer $index Índice de base cero en el que debe insertarse
49-
* $item.
50-
* @param mixed $item Objeto que se va a insertar.
51-
*
52-
* @return void
53-
* */
54-
public function insert($index, $item);
45+
/**
46+
* Inserta un elemento en la lista, en el índice especificado.
47+
*
48+
* @param integer $index Índice de base cero en el que debe insertarse
49+
* $item.
50+
* @param mixed $item Objeto que se va a insertar.
51+
*
52+
* @return void
53+
* */
54+
public function insert($index, $item);
5555

5656

57-
/**
58-
* Quita el elemento del índice especificado.
59-
*
60-
* @param integer $index Índice de base cero del elemento que se va a
61-
* quitar.
62-
*
63-
* @return boolean `true` si el elemento se ha quitado correctamente; en
64-
* caso contrario, `false`. Este método también devuelve `false` si no
65-
* se encontró.
66-
* */
67-
public function removeAt($index);
68-
}
57+
/**
58+
* Quita el elemento del índice especificado.
59+
*
60+
* @param integer $index Índice de base cero del elemento que se va a
61+
* quitar.
62+
*
63+
* @return boolean `true` si el elemento se ha quitado correctamente; en
64+
* caso contrario, `false`. Este método también devuelve `false` si no
65+
* se encontró.
66+
* */
67+
public function removeAt($index);
6968
}

src/IComparable.php

+39-40
Original file line numberDiff line numberDiff line change
@@ -17,49 +17,48 @@
1717
* @license http://www.opensource.org/licenses/mit-license.php The MIT License (MIT)
1818
* */
1919

20-
namespace NelsonMartell {
20+
namespace NelsonMartell;
21+
22+
/**
23+
* Provee métodos para comparar posición relativa de instancia.
24+
*
25+
* @author Nelson Martell <nelson6e65@gmail.com>
26+
* */
27+
interface IComparable
28+
{
2129

2230
/**
23-
* Provee métodos para comparar posición relativa de instancia.
31+
* Determina la posición relativa de esta instancia con respecto al objeto especificado.
32+
*
33+
*
34+
* @param mixed $other Objeto con el cuál se va a comparar posición relativa de esta instancia.
2435
*
25-
* @author Nelson Martell <nelson6e65@gmail.com>
36+
* @return integer|null
37+
* Debe devolver:
38+
* - ``= 0`` si esta instancia se considera equivalente a $other;
39+
* - ``> 0`` si esta instancia se considera mayor a $other;
40+
* - ``< 0`` si esta instancia se considera menor a $other.
41+
* - ``null`` si esta instancia no se puede comparar a $other.
42+
*
43+
* @see IComparer::compare()
2644
* */
27-
interface IComparable
28-
{
29-
30-
/**
31-
* Determina la posición relativa de esta instancia con respecto al objeto especificado.
32-
*
33-
*
34-
* @param mixed $other Objeto con el cuál se va a comparar posición relativa de esta instancia.
35-
*
36-
* @return integer|null
37-
* Debe devolver:
38-
* - ``= 0`` si esta instancia se considera equivalente a $other;
39-
* - ``> 0`` si esta instancia se considera mayor a $other;
40-
* - ``< 0`` si esta instancia se considera menor a $other.
41-
* - ``null`` si esta instancia no se puede comparar a $other.
42-
*
43-
* @see IComparer::compare()
44-
* */
45-
public function compareTo($other);
45+
public function compareTo($other);
4646

47-
/**
48-
* Determina la posición relativa del objeto de la izquierda con respecto al de la derecha.
49-
* Puede usarse como segundo argumento en la función de ordenamiento de arrays ``usort()``.
50-
*
51-
* @param mixed $left Objeto al que se le va a determinar la posición relativa.
52-
* @param mixed $right Objeto con el cuál se va a comparar posición relativa del de la izquierda.
53-
*
54-
* @return integer|null
55-
* Debe devolver:
56-
* - ``= 0`` si $left se considera equivalente a $right;
57-
* - ``> 0`` si $left se considera mayor a $right;
58-
* - ``< 0`` si $left se considera menor a $right.
59-
* - ``null`` si no se pueden comparar entre sí. (Al usar ``usort()`` se considerarán equivalentes)
60-
* @see IComparer::compare()
61-
* @deprecated since v0.6.0; implement ``NelsonMartell\IComparer`` instead.
62-
* */
63-
public static function compare($left, $right);
64-
}
47+
/**
48+
* Determina la posición relativa del objeto de la izquierda con respecto al de la derecha.
49+
* Puede usarse como segundo argumento en la función de ordenamiento de arrays ``usort()``.
50+
*
51+
* @param mixed $left Objeto al que se le va a determinar la posición relativa.
52+
* @param mixed $right Objeto con el cuál se va a comparar posición relativa del de la izquierda.
53+
*
54+
* @return integer|null
55+
* Debe devolver:
56+
* - ``= 0`` si $left se considera equivalente a $right;
57+
* - ``> 0`` si $left se considera mayor a $right;
58+
* - ``< 0`` si $left se considera menor a $right.
59+
* - ``null`` si no se pueden comparar entre sí. (Al usar ``usort()`` se considerarán equivalentes)
60+
* @see IComparer::compare()
61+
* @deprecated since v0.6.0; implement ``NelsonMartell\IComparer`` instead.
62+
* */
63+
public static function compare($left, $right);
6564
}

src/IComparer.php

+24-25
Original file line numberDiff line numberDiff line change
@@ -17,33 +17,32 @@
1717
* @license http://www.opensource.org/licenses/mit-license.php The MIT License (MIT)
1818
* */
1919

20-
namespace NelsonMartell {
20+
namespace NelsonMartell;
2121

22+
/**
23+
* Provee métodos para comparar posición relativa entre objetos.
24+
*
25+
* @author Nelson Martell <nelson6e65@gmail.com>
26+
* @see IComparable
27+
* */
28+
interface IComparer
29+
{
2230
/**
23-
* Provee métodos para comparar posición relativa entre objetos.
31+
* Compara dos objetos y devuelve un valor que indica si uno es menor, igual o mayor que el otro.
32+
*
33+
* Puede usarse como segundo argumento en la función de ordenamiento de arrays ``usort()``.
34+
*
35+
* @param mixed $left Objeto al que se le va a determinar la posición relativa.
36+
* @param mixed $right Objeto con el cuál se va a comparar posición relativa del de la izquierda.
2437
*
25-
* @author Nelson Martell <nelson6e65@gmail.com>
26-
* @see IComparable
38+
* @return integer|null
39+
* Debe devolver:
40+
* - ``= 0`` si $left se considera equivalente a $right;
41+
* - ``> 0`` si $left se considera mayor a $right;
42+
* - ``< 0`` si $left se considera menor a $right.
43+
* - ``null`` si no se pueden comparar entre sí. (Al usar ``usort()`` se considerarán equivalentes)
44+
* @see \usort()
45+
* @see IComparable::compareTo
2746
* */
28-
interface IComparer
29-
{
30-
/**
31-
* Compara dos objetos y devuelve un valor que indica si uno es menor, igual o mayor que el otro.
32-
*
33-
* Puede usarse como segundo argumento en la función de ordenamiento de arrays ``usort()``.
34-
*
35-
* @param mixed $left Objeto al que se le va a determinar la posición relativa.
36-
* @param mixed $right Objeto con el cuál se va a comparar posición relativa del de la izquierda.
37-
*
38-
* @return integer|null
39-
* Debe devolver:
40-
* - ``= 0`` si $left se considera equivalente a $right;
41-
* - ``> 0`` si $left se considera mayor a $right;
42-
* - ``< 0`` si $left se considera menor a $right.
43-
* - ``null`` si no se pueden comparar entre sí. (Al usar ``usort()`` se considerarán equivalentes)
44-
* @see \usort()
45-
* @see IComparable::compareTo
46-
* */
47-
public static function compare($left, $right);
48-
}
47+
public static function compare($left, $right);
4948
}

0 commit comments

Comments
 (0)