diff --git a/src/CursorPosition.php b/src/Position.php similarity index 62% rename from src/CursorPosition.php rename to src/Position.php index 19383d6f5f3328c01fbc1db361e43fee502e0e22..ff4f2038ba95546ca86dc56747a6cdd3caecc35f 100644 --- a/src/CursorPosition.php +++ b/src/Position.php @@ -13,19 +13,19 @@ namespace Grifart\Mappi\Cursor; * @link https://github.com/nicolopignatelli/valueobjects (inspiration) * @package Grifart\Mappi\Cursor */ -final class CursorPosition +final class Position { - /** @var CursorPositionOrigin */ + /** @var PositionOrigin */ private $origin; /** @var int the cursor position */ private $position = 0; /** - * @param CursorPositionOrigin $origin from left or from right? - * @param int $position which position + * @param PositionOrigin $origin from left or from right? + * @param int $position which position */ - public function __construct(CursorPositionOrigin $origin, int $position) + public function __construct(PositionOrigin $origin, int $position) { $this->setPosition($origin, $position); } @@ -33,7 +33,7 @@ final class CursorPosition public static function fromLeft(int $position) : self { return new self( - CursorPositionOrigin::get(CursorPositionOrigin::FROM_LEFT), + PositionOrigin::get(PositionOrigin::FROM_LEFT), $position ); } @@ -41,22 +41,22 @@ final class CursorPosition public static function fromRight(int $position) : self { return new self( - CursorPositionOrigin::get(CursorPositionOrigin::FROM_RIGHT), + PositionOrigin::get(PositionOrigin::FROM_RIGHT), $position ); } public function setPositionFromLeft(int $position) { - $this->setPosition(CursorPositionOrigin::get(CursorPositionOrigin::FROM_LEFT), $position); + $this->setPosition(PositionOrigin::get(PositionOrigin::FROM_LEFT), $position); } public function setPositionFromRight(int $position) { - $this->setPosition(CursorPositionOrigin::get(CursorPositionOrigin::FROM_RIGHT), $position); + $this->setPosition(PositionOrigin::get(PositionOrigin::FROM_RIGHT), $position); } - private function setPosition(CursorPositionOrigin $origin, int $position) + private function setPosition(PositionOrigin $origin, int $position) { if($position < 0) { throw CursorException::cursorPosition_invalidIndexValue($position); @@ -71,7 +71,7 @@ final class CursorPosition public function movePositionBy(int $by) { $modifier = 1; - if ($this->origin->is(CursorPositionOrigin::FROM_RIGHT)) { + if ($this->origin->is(PositionOrigin::FROM_RIGHT)) { $modifier = -1; } $this->position += $modifier * $by; @@ -79,7 +79,7 @@ final class CursorPosition /** * From which side is position counted? - * @return CursorPositionOrigin + * @return PositionOrigin */ public function getOrigin() { @@ -97,6 +97,6 @@ final class CursorPosition function __toString() : string { - return ($this->origin->getValue() === CursorPositionOrigin::FROM_LEFT ? "left:" : "right:") . $this->position; + return ($this->origin->getValue() === PositionOrigin::FROM_LEFT ? "left:" : "right:") . $this->position; } } \ No newline at end of file diff --git a/src/CursorPositionOrigin.php b/src/PositionOrigin.php similarity index 82% rename from src/CursorPositionOrigin.php rename to src/PositionOrigin.php index 41dabea689623fabd2cc317b486c10212afbfd26..89b18f242ee193b6ba4d5a237a07e8ded0274e3d 100644 --- a/src/CursorPositionOrigin.php +++ b/src/PositionOrigin.php @@ -7,7 +7,7 @@ namespace Grifart\Mappi\Cursor; use MabeEnum\Enum; -class CursorPositionOrigin extends Enum +class PositionOrigin extends Enum { const FROM_LEFT = 0; const FROM_RIGHT = 1; diff --git a/src/TrackedCursor.php b/src/TrackedCursor.php index b4ddd27feac99a5004cc39a76c6913247d4bafc7..2d1ceb290b6fe9cac4e47779acdce74f26908cbe 100644 --- a/src/TrackedCursor.php +++ b/src/TrackedCursor.php @@ -7,7 +7,7 @@ namespace Grifart\Mappi\Cursor; class TrackedCursor implements ICursor { - /** @var CursorPosition */ + /** @var Position */ private $position; /** @var ICursor */ @@ -16,17 +16,17 @@ class TrackedCursor implements ICursor /** * Tip: if you are not sure that cursor will be in initial state, call * ->moveToBeginning() after initialization. - * @param ICursor $cursor Cursor in initial state (index=0) - * @param CursorPosition $initialPosition + * @param ICursor $cursor Cursor in initial state (index=0) + * @param Position $initialPosition */ - public function __construct(ICursor $cursor, CursorPosition $initialPosition) + public function __construct(ICursor $cursor, Position $initialPosition) { $this->cursor = $cursor; $this->position = $initialPosition; } /** - * @return CursorPosition + * @return Position */ public function getPosition() { diff --git a/tests/Cursor/TrackedCursorTest.phpt b/tests/Cursor/TrackedCursorTest.phpt index ade58f53bb5534aeab914d2415ab9dca8dab912e..dedd795ac33e7d42403f39b8fe25968705e6c00b 100644 --- a/tests/Cursor/TrackedCursorTest.phpt +++ b/tests/Cursor/TrackedCursorTest.phpt @@ -9,7 +9,7 @@ namespace Grifart\Mappi\Tests\Cursor; use Grifart\Mappi\Cursor\Cursor; -use Grifart\Mappi\Cursor\CursorPosition; +use Grifart\Mappi\Cursor\Position; use Grifart\Mappi\Tests\Cursor\Driver\ArrayCursorDriver; use Grifart\Mappi\Cursor\TrackedCursor; use Tester\Assert; @@ -36,7 +36,7 @@ class TrackedCursorTest extends ICursorTest $this->uut = new TrackedCursor( $cursor, - CursorPosition::fromLeft(0) + Position::fromLeft(0) ); parent::setUp(); }