aimeos / ai-controller-jobs

controller/jobs/tests/Controller/Jobs/Product/Export/StandardTest.php

Spacing +14 added lines, -14 removed lines

@@ -18,18 +18,18 @@ 
 
 	protected function setUp()
 	{
-		\Aimeos\MShop\Factory::setCache( true );
+		\Aimeos\MShop\Factory::setCache(true);
 
 		$this->context = \TestHelperJobs::getContext();
 		$this->aimeos = \TestHelperJobs::getAimeos();
 
-		$this->object = new \Aimeos\Controller\Jobs\Product\Export\Standard( $this->context, $this->aimeos );
+		$this->object = new \Aimeos\Controller\Jobs\Product\Export\Standard($this->context, $this->aimeos);
 	}
 
 
 	protected function tearDown()
 	{
-		\Aimeos\MShop\Factory::setCache( false );
+		\Aimeos\MShop\Factory::setCache(false);
 		\Aimeos\MShop\Factory::clear();
 
 		$this->object = null;
@@ -38,34 +38,34 @@ 
 
 	public function testGetName()
 	{
-		$this->assertEquals( 'Product export', $this->object->getName() );
+		$this->assertEquals('Product export', $this->object->getName());
 	}
 
 
 	public function testGetDescription()
 	{
 		$text = 'Exports all available products';
-		$this->assertEquals( $text, $this->object->getDescription() );
+		$this->assertEquals($text, $this->object->getDescription());
 	}
 
 
 	public function testRun()
 	{
-		$this->context->getConfig()->set( 'controller/jobs/product/export/filename', 'aimeos-products-%1$d.xml' );
+		$this->context->getConfig()->set('controller/jobs/product/export/filename', 'aimeos-products-%1$d.xml');
 
 		$this->object->run();
 
 		$ds = DIRECTORY_SEPARATOR;
-		$this->assertFileExists( 'tmp' . $ds . 'aimeos-products-1.xml' );
-		$this->assertFileExists( 'tmp' . $ds . 'aimeos-products-2.xml' );
+		$this->assertFileExists('tmp' . $ds . 'aimeos-products-1.xml');
+		$this->assertFileExists('tmp' . $ds . 'aimeos-products-2.xml');
 
-		$file1 = file_get_contents( 'tmp' . $ds . 'aimeos-products-1.xml' );
-		$file2 = file_get_contents( 'tmp' . $ds . 'aimeos-products-2.xml' );
+		$file1 = file_get_contents('tmp' . $ds . 'aimeos-products-1.xml');
+		$file2 = file_get_contents('tmp' . $ds . 'aimeos-products-2.xml');
 
-		unlink( 'tmp' . $ds . 'aimeos-products-1.xml' );
-		unlink( 'tmp' . $ds . 'aimeos-products-2.xml' );
+		unlink('tmp' . $ds . 'aimeos-products-1.xml');
+		unlink('tmp' . $ds . 'aimeos-products-2.xml');
 
-		$this->assertContains( 'CNE', $file1 );
-		$this->assertContains( 'U:BUNDLE', $file2 );
+		$this->assertContains('CNE', $file1);
+		$this->assertContains('U:BUNDLE', $file2);
 	}
 }
\ No newline at end of file

controller/jobs/src/Controller/Jobs/Product/Export/Standard.php

Doc Comments +1 added lines, -1 removed lines

@@ -275,7 +275,7 @@
 	 *
 	 * @param \Aimeos\MW\Container\Iface $container Container object
 	 * @param boolean $default True to filter exported products by default criteria
-	 * @return array List of content (file) names
+	 * @return string[] List of content (file) names
 	 */
 	protected function export( \Aimeos\MW\Container\Iface $container, $default = true )
 	{

Spacing +45 added lines, -45 removed lines

@@ -28,7 +28,7 @@ 
 	 */
 	public function getName()
 	{
-		return $this->getContext()->getI18n()->dt( 'controller/jobs', 'Product export' );
+		return $this->getContext()->getI18n()->dt('controller/jobs', 'Product export');
 	}
 
 
@@ -39,7 +39,7 @@ 
 	 */
 	public function getDescription()
 	{
-		return $this->getContext()->getI18n()->dt( 'controller/jobs', 'Exports all available products' );
+		return $this->getContext()->getI18n()->dt('controller/jobs', 'Exports all available products');
 	}
 
 
@@ -51,7 +51,7 @@ 
 	public function run()
 	{
 		$container = $this->createContainer();
-		$this->export( $container, false );
+		$this->export($container, false);
 		$container->close();
 	}
 
@@ -62,7 +62,7 @@ 
 	 * @param \Aimeos\MW\Container\Content\Iface $content File content object
 	 * @param \Aimeos\MShop\Product\Item\Iface[] $items List of product items
 	 */
-	protected function addItems( \Aimeos\MW\Container\Content\Iface $content, array $items )
+	protected function addItems(\Aimeos\MW\Container\Content\Iface $content, array $items)
 	{
 		/** controller/jobs/product/export/standard/template-items
 		 * Relative path to the XML items template of the product site map job controller.
@@ -94,7 +94,7 @@ 
 
 		$view->exportItems = $items;
 
-		$content->add( $view->render( $context->getConfig()->get( $tplconf, $default ) ) );
+		$content->add($view->render($context->getConfig()->get($tplconf, $default)));
 	}
 
 
@@ -123,7 +123,7 @@ 
 		 * @see controller/jobs/product/export/max-items
 		 * @see controller/jobs/product/export/max-query
 		 */
-		$location = $config->get( 'controller/jobs/product/export/location' );
+		$location = $config->get('controller/jobs/product/export/location');
 
 		/** controller/jobs/product/export/standard/container/type
 		 * List of file container options for the export files
@@ -140,7 +140,7 @@ 
 		 * @see controller/jobs/product/export/max-items
 		 * @see controller/jobs/product/export/max-query
 		 */
-		$container = $config->get( 'controller/jobs/product/export/standard/container/type', 'Directory' );
+		$container = $config->get('controller/jobs/product/export/standard/container/type', 'Directory');
 
 		/** controller/jobs/product/export/standard/container/content
 		 * List of file container options for the export files
@@ -157,7 +157,7 @@ 
 		 * @see controller/jobs/product/export/max-items
 		 * @see controller/jobs/product/export/max-query
 		 */
-		$content = $config->get( 'controller/jobs/product/export/standard/container/content', 'Binary' );
+		$content = $config->get('controller/jobs/product/export/standard/container/content', 'Binary');
 
 		/** controller/jobs/product/export/standard/container/options
 		 * List of file container options for the export files
@@ -174,15 +174,15 @@ 
 		 * @see controller/jobs/product/export/max-items
 		 * @see controller/jobs/product/export/max-query
 		 */
-		$options = $config->get( 'controller/jobs/product/export/standard/container/options', [] );
+		$options = $config->get('controller/jobs/product/export/standard/container/options', []);
 
-		if( $location === null )
+		if ($location === null)
 		{
-			$msg = sprintf( 'Required configuration for "%1$s" is missing', 'controller/jobs/product/export/location' );
-			throw new \Aimeos\Controller\Jobs\Exception( $msg );
+			$msg = sprintf('Required configuration for "%1$s" is missing', 'controller/jobs/product/export/location');
+			throw new \Aimeos\Controller\Jobs\Exception($msg);
 		}
 
-		return \Aimeos\MW\Container\Factory::getContainer( $location, $container, $content, $options );
+		return \Aimeos\MW\Container\Factory::getContainer($location, $container, $content, $options);
 	}
 
 
@@ -193,7 +193,7 @@ 
 	 * @param integer $filenum New file number
 	 * @return \Aimeos\MW\Container\Content\Iface New content object
 	 */
-	protected function createContent( \Aimeos\MW\Container\Iface $container, $filenum )
+	protected function createContent(\Aimeos\MW\Container\Iface $container, $filenum)
 	{
 		/** controller/jobs/product/export/standard/template-header
 		 * Relative path to the XML site map header template of the product site map job controller.
@@ -223,9 +223,9 @@ 
 		$context = $this->getContext();
 		$view = $context->getView();
 
-		$content = $container->create( $this->getFilename( $filenum ) );
-		$content->add( $view->render( $context->getConfig()->get( $tplconf, $default ) ) );
-		$container->add( $content );
+		$content = $container->create($this->getFilename($filenum));
+		$content->add($view->render($context->getConfig()->get($tplconf, $default)));
+		$container->add($content);
 
 		return $content;
 	}
@@ -236,7 +236,7 @@ 
 	 *
 	 * @param \Aimeos\MW\Container\Content\Iface $content
 	 */
-	protected function closeContent( \Aimeos\MW\Container\Content\Iface $content )
+	protected function closeContent(\Aimeos\MW\Container\Content\Iface $content)
 	{
 		/** controller/jobs/product/export/standard/template-footer
 		 * Relative path to the XML site map footer template of the product site map job controller.
@@ -266,7 +266,7 @@ 
 		$context = $this->getContext();
 		$view = $context->getView();
 
-		$content->add( $view->render( $context->getConfig()->get( $tplconf, $default ) ) );
+		$content->add($view->render($context->getConfig()->get($tplconf, $default)));
 	}
 
 
@@ -277,50 +277,50 @@ 
 	 * @param boolean $default True to filter exported products by default criteria
 	 * @return array List of content (file) names
 	 */
-	protected function export( \Aimeos\MW\Container\Iface $container, $default = true )
+	protected function export(\Aimeos\MW\Container\Iface $container, $default = true)
 	{
-		$domains = array( 'attribute', 'media', 'price', 'product', 'text' );
+		$domains = array('attribute', 'media', 'price', 'product', 'text');
 
-		$domains = $this->getConfig( 'domains', $domains );
-		$maxItems = $this->getConfig( 'max-items', 10000 );
-		$maxQuery = $this->getConfig( 'max-query', 200 );
+		$domains = $this->getConfig('domains', $domains);
+		$maxItems = $this->getConfig('max-items', 10000);
+		$maxQuery = $this->getConfig('max-query', 200);
 
 		$start = 0; $filenum = 1;
 		$names = [];
 
-		$indexManager = \Aimeos\MShop\Index\Manager\Factory::createManager( $this->getContext() );
+		$indexManager = \Aimeos\MShop\Index\Manager\Factory::createManager($this->getContext());
 
-		$search = $indexManager->createSearch( $default );
-		$search->setSlice( 0, $maxQuery );
+		$search = $indexManager->createSearch($default);
+		$search->setSlice(0, $maxQuery);
 		$search->setConditions(
-			$search->compare( '!=', 'index.catalog.id', null )
+			$search->compare('!=', 'index.catalog.id', null)
 		);
 		$search->setSortations(
-			[ $search->sort('+', 'product.id') ]
+			[$search->sort('+', 'product.id')]
 		);
 
 		$content = $this->createContent($container, $filenum);
-		$names[] = basename( $content->getResource() );
+		$names[] = basename($content->getResource());
 
 		do
 		{
 			$items = $indexManager->searchItems($search, $domains);
 			$this->addItems($content, $items);
 
-			$count = count( $items );
+			$count = count($items);
 			$start += $count;
-			$search->setSlice( $start, $maxQuery );
+			$search->setSlice($start, $maxQuery);
 
-			if( $start + $maxQuery > $maxItems * $filenum )
+			if ($start + $maxQuery > $maxItems * $filenum)
 			{
-				$this->closeContent( $content );
-				$content = $this->createContent( $container, ++$filenum );
+				$this->closeContent($content);
+				$content = $this->createContent($container, ++$filenum);
 				$names[] = basename($content->getResource());
 			}
 		}
-		while( $count >= $search->getSliceSize() );
+		while ($count >= $search->getSliceSize());
 
-		$this->closeContent( $content );
+		$this->closeContent($content);
 
 		return $names;
 	}
@@ -333,11 +333,11 @@ 
 	 * @param mixed $default Default value if name is unknown
 	 * @return mixed Configuration value
 	 */
-	protected function getConfig( $name, $default = null )
+	protected function getConfig($name, $default = null)
 	{
 		$config = $this->getContext()->getConfig();
 
-		switch( $name )
+		switch ($name)
 		{
 			case 'domain':
 				/** controller/jobs/product/export/domains
@@ -360,7 +360,7 @@ 
 				 * @see controller/jobs/product/export/max-items
 				 * @see controller/jobs/product/export/max-query
 				 */
-				return $config->get( 'controller/jobs/product/export/domains', $default );
+				return $config->get('controller/jobs/product/export/domains', $default);
 
 			case 'max-items':
 				/** controller/jobs/product/export/max-items
@@ -383,7 +383,7 @@ 
 				 * @see controller/jobs/product/export/max-query
 				 * @see controller/jobs/product/export/domains
 				 */
-				return $config->get( 'controller/jobs/product/export/max-items', $default );
+				return $config->get('controller/jobs/product/export/max-items', $default);
 
 			case 'max-query':
 				/** controller/jobs/product/export/max-query
@@ -406,7 +406,7 @@ 
 				 * @see controller/jobs/product/export/max-items
 				 * @see controller/jobs/product/export/domains
 				 */
-				return $config->get( 'controller/jobs/product/export/max-query', $default );
+				return $config->get('controller/jobs/product/export/max-query', $default);
 
 			case 'filename':
 				/** controller/jobs/product/export/filename
@@ -427,7 +427,7 @@ 
 				 * @see controller/jobs/product/export/max-query
 				 * @see controller/jobs/product/export/domains
 				 */
-				return $config->get( 'controller/jobs/product/export/filename', $default );
+				return $config->get('controller/jobs/product/export/filename', $default);
 		}
 
 		return $default;
@@ -440,8 +440,8 @@ 
 	 * @param integer $number Current file number
 	 * @return string New file name
 	 */
-	protected function getFilename( $number )
+	protected function getFilename($number)
 	{
-		return sprintf( $this->getConfig( 'filename', 'aimeos-products-%1$d_%2$s.xml' ), $number, date( 'Y-m-d_H:i:s' ) );
+		return sprintf($this->getConfig('filename', 'aimeos-products-%1$d_%2$s.xml'), $number, date('Y-m-d_H:i:s'));
 	}
 }