Added stock() method to filter by stock level

aimeos · Dec 7, 2020 · 4e1b507 · 4e1b507
1 parent b7775a0
commit 4e1b507
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 0 deletions.
diff --git a/controller/frontend/src/Controller/Frontend/Product/Decorator/Base.php b/controller/frontend/src/Controller/Frontend/Product/Decorator/Base.php
@@ -305,6 +305,20 @@ public function sort( string $key = null ) : \Aimeos\Controller\Frontend\Product
 	}
 
 
+	/**
+	 * Adds minimum stock level for filtering
+	 *
+	 * @param string|int|float|null Minimum stock level
+	 * @return \Aimeos\Controller\Frontend\Product\Iface Product controller for fluent interface
+	 * @since 2021.01
+	 */
+	public function stock( $minvalue )
+	{
+		$this->controller->stock( $minvalue );
+		return $this;
+	}
+
+
 	/**
 	 * Adds supplier IDs for filtering
 	 *

diff --git a/controller/frontend/src/Controller/Frontend/Product/Iface.php b/controller/frontend/src/Controller/Frontend/Product/Iface.php
@@ -174,6 +174,15 @@ public function slice( int $start, int $limit ) : Iface;
 	 */
 	public function sort( string $key = null ) : Iface;
 
+	/**
+	 * Adds minimum stock level for filtering
+	 *
+	 * @param string|int|float|null Minimum stock level
+	 * @return \Aimeos\Controller\Frontend\Product\Iface Product controller for fluent interface
+	 * @since 2021.01
+	 */
+	public function stock( $minvalue );
+
 	/**
 	 * Adds supplier IDs for filtering
 	 *

diff --git a/controller/frontend/src/Controller/Frontend/Product/Standard.php b/controller/frontend/src/Controller/Frontend/Product/Standard.php
@@ -425,6 +425,24 @@ public function sort( string $key = null ) : Iface
 	}
 
 
+	/**
+	 * Adds minimum stock level for filtering
+	 *
+	 * @param string|int|float|null Minimum stock level
+	 * @return \Aimeos\Controller\Frontend\Product\Iface Product controller for fluent interface
+	 * @since 2021.01
+	 */
+	public function stock( $minvalue )
+	{
+		$this->conditions['stock'] = $this->filter->or( [
+			$this->filter->is( 'stock.stocklevel', '>=', $minvalue ),
+			$this->filter->is( 'stock.stocklevel', '==', null )
+		] );
+
+		return $this;
+	}
+
+
 	/**
 	 * Adds supplier IDs for filtering
 	 *

diff --git a/controller/frontend/tests/Controller/Frontend/Product/Decorator/BaseTest.php b/controller/frontend/tests/Controller/Frontend/Product/Decorator/BaseTest.php
@@ -198,6 +198,12 @@ public function testSort()
 	}
 
 
+	public function testStock()
+	{
+		$this->assertSame( $this->object, $this->object->stock( 123 ) );
+	}
+
+
 	public function testSupplier()
 	{
 		$this->assertSame( $this->object, $this->object->supplier( [1], 'default' ) );

diff --git a/controller/frontend/tests/Controller/Frontend/Product/StandardTest.php b/controller/frontend/tests/Controller/Frontend/Product/StandardTest.php
@@ -300,6 +300,15 @@ public function testSortRelevanceSupplier()
 	}
 
 
+	public function testStock()
+	{
+		$this->assertEquals( 6, count( $this->object->stock( 0 )->search() ) );
+		$this->assertEquals( 6, count( $this->object->stock( '1' )->search() ) );
+		$this->assertEquals( 6, count( $this->object->stock( 1.5 )->search() ) );
+		$this->assertEquals( 6, count( $this->object->stock( null )->search() ) );
+	}
+
+
 	public function testSupplier()
 	{
 		$manager = \Aimeos\MShop::create( $this->context, 'supplier' );