Base::batchBase() - Code Metrics - Inspection of "Streamlined batch implementation for types" - aimeos/ai-admin-jqadm - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 6ab2f3...c0a629 )

by Aimeos
created 2022-06-23 17:26 UTC
Base::batchBase() A

↳ Parent: Base
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	2
dl	0
loc	3
rs	10
<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2017-2022
 * @package Admin
 * @subpackage JQAdm
 */


namespace Aimeos\Admin\JQAdm\Type;


/**
 * Base implementation of type JQAdm clients.
 *
 * @package Admin
 * @subpackage JQAdm
 */
abstract class Base
	extends \Aimeos\Admin\JQAdm\Common\Admin\Factory\Base
	implements \Aimeos\Admin\JQAdm\Common\Admin\Factory\Iface
{
	/**
	 * Adds the required data used in the template
	 *
	 * @param \Aimeos\Base\View\Iface $view View object
	 * @return \Aimeos\Base\View\Iface View object with assigned parameters
	 */
	public function data( \Aimeos\Base\View\Iface $view ) : \Aimeos\Base\View\Iface
	{
		$view->itemSubparts = $this->getSubClientNames();
		return $view;
	}


	/**
	 * Returns the rendered template including the view data
	 *
	 * @param \Aimeos\Base\View\Iface $view View object with data assigned
	 * @return string HTML output
	 */
	abstract protected function render( \Aimeos\Base\View\Iface $view ) : string;


	/**
	 * Modifiy several items at once
	 *
	 * @param string $domain Data domain of the items
	 * @param string|null $resource Resource name or null for domain name
	 * @return string|null Output to display
	 */
	protected function batchBase( string $domain, string $resource = null ) : ?string
	{
		return parent::batchBase( $domain . '/type', 'type/' . $domain );
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
	}


	/**
	 * Copies a resource
	 *
	 * @param string $path Path name like "attribute/lists" without "/type" postfix
	 * @return string|null HTML output
	 */
	protected function copyBase( string $path ) : string
	{
		$view = $this->object()->data( $this->view() );

		try
		{
			if( ( $id = $view->param( 'id' ) ) === null )
			{
				$msg = $this->context()->translate( 'admin', 'Required parameter "%1$s" is missing' );
				throw new \Aimeos\Admin\JQAdm\Exception( sprintf( $msg, 'id' ) );
			}

			$manager = \Aimeos\MShop::create( $this->context(), $path . '/type' );
			$view->item = $manager->get( $id );

			$view->itemData = $this->toArray( $path, $view->item, true );
			$view->itemBody = parent::copy();
		}
		catch( \Exception $e )
		{
			$this->report( $e, 'copy' );
		}

		return $this->render( $view );
	}


	/**
	 * Creates a new resource
	 *
	 * @param string $path Path name like "attribute/lists" without "/type" postfix
	 * @return string|null HTML output
	 */
	public function createBase( string $path ) : string
	{
		$view = $this->object()->data( $this->view() );

		try
		{
			$data = $view->param( 'item', [] );

			if( !isset( $view->item ) ) {
				$view->item = \Aimeos\MShop::create( $this->context(), $path . '/type' )->create();
			}

			$data[str_replace( '/', '.', $path ) . '.type.siteid'] = $view->item->getSiteId();

			$view->itemData = array_replace_recursive( $this->toArray( $path, $view->item ), $data );
			$view->itemBody = parent::create();
		}
		catch( \Exception $e )
		{
			$this->report( $e, 'create' );
		}

		return $this->render( $view );
	}


	/**
	 * Deletes a resource
	 *
	 * @param string $path Path name like "attribute/lists" without "/type" postfix
	 * @return string|null HTML output
	 */
	public function deleteBase( string $path ) : ?string
	{
		$view = $this->view();

		$manager = \Aimeos\MShop::create( $this->context(), $path . '/type' );
		$manager->begin();

		try
		{
			if( ( $ids = $view->param( 'id' ) ) === null )
			{
				$msg = $this->context()->translate( 'admin', 'Required parameter "%1$s" is missing' );
				throw new \Aimeos\Admin\JQAdm\Exception( sprintf( $msg, 'id' ) );
			}

			$search = $manager->filter()->slice( 0, count( (array) $ids ) );
			$search->setConditions( $search->compare( '==', str_replace( '/', '.', $path ) . '.type.id', $ids ) );
			$items = $manager->search( $search );

			foreach( $items as $item )
			{
				$view->item = $item;
				parent::delete();
			}

			$manager->delete( $items->toArray() );
			$manager->commit();

			return $this->redirect( 'type/' . $path, 'search', null, 'delete' );
		}
		catch( \Exception $e )
		{
			$this->report( $e, 'delete' );
		}

		$manager->rollback();

		return $this->search();
	}


	/**
	 * Returns a single resource
	 *
	 * @param string $path Path name like "attribute/lists" without "/type" postfix
	 * @return string|null HTML output
	 */
	public function getBase( string $path ) : string
	{
		$view = $this->object()->data( $this->view() );

		try
		{
			if( ( $id = $view->param( 'id' ) ) === null )
			{
				$msg = $this->context()->translate( 'admin', 'Required parameter "%1$s" is missing' );
				throw new \Aimeos\Admin\JQAdm\Exception( sprintf( $msg, 'id' ) );
			}

			$manager = \Aimeos\MShop::create( $this->context(), $path . '/type' );

			$view->item = $manager->get( $id );
			$view->itemData = $this->toArray( $path, $view->item );
			$view->itemBody = parent::get();
		}
		catch( \Exception $e )
		{
			$this->report( $e, 'get' );
		}

		return $this->render( $view );
	}


	/**
	 * Saves the data
	 *
	 * @param string $path Path name like "attribute/lists" without "/type" postfix
	 * @return string|null HTML output
	 */
	public function saveBase( string $path ) : ?string
	{
		$view = $this->view();

		$manager = \Aimeos\MShop::create( $this->context(), $path . '/type' );
		$manager->begin();

		try
		{
			$item = $this->fromArray( $path, $view->param( 'item', [] ) );
			$view->item = $item->getId() ? $item : $manager->save( $item );
			$view->itemBody = parent::save();

			$manager->save( clone $view->item );
			$manager->commit();

			return $this->redirect( 'type/' . $path, $view->param( 'next' ), $view->item->getId(), 'save' );
			return $this->redirect( 'type/' . $path, $view->param( 'next' ), /** @scrutinizer ignore-type */ $view->item->getId(), 'save' );
		}
		catch( \Exception $e )
		{
			$manager->rollback();
			$this->report( $e, 'save' );
		}

		return $this->create();
	}


	/**
	 * Returns a list of resource according to the conditions
	 *
	 * @param string $path Path name like "attribute/lists" without "/type" postfix
	 * @return \Aimeos\Base\View\Iface View object ready for rendering
	 */
	public function searchBase( string $path ) : \Aimeos\Base\View\Iface
	{
		$view = $this->view();

		try
		{
			$total = 0;
			$params = $this->storeFilter( $view->param(), 'type/' . $path );
			$manager = \Aimeos\MShop::create( $this->context(), $path . '/type' );
			$search = $this->initCriteria( $manager->filter(), $params );

			$view->items = $manager->search( $search, [], $total );
			$view->filterAttributes = $manager->getSearchAttributes( true );
			$view->filterOperators = $search->getOperators();
			$view->itemBody = parent::search();
			$view->total = $total;
		}
		catch( \Exception $e )
		{
			$this->report( $e, 'search' );
		}

		return $view;
	}


	/**
	 * Creates new and updates existing items using the data array
	 *
	 * @param string $path Path name like "attribute/lists" without "/type" postfix
	 * @param array $data Data array
	 * @return \Aimeos\MShop\Common\Item\Type\Iface New type item object
	 */
	protected function fromArray( string $path, array $data ) : \Aimeos\MShop\Common\Item\Type\Iface
	{
		$key = str_replace( '/', '.', $path ) . '.type.id';
		$manager = \Aimeos\MShop::create( $this->context(), $path . '/type' );

		if( isset( $data[$key] ) && $data[$key] != '' ) {
			$item = $manager->get( $data[$key] );
		} else {
			$item = $manager->create();
		}

		$item->fromArray( $data, true );

		return $item;
	}


	/**
	 * Constructs the data array for the view from the given item
	 *
	 * @param string $path Path name like "attribute/lists" without "/type" postfix
	 * @param \Aimeos\MShop\Common\Item\Type\Iface $item Type item object
	 * @param bool True if item is going to be copied, false if not
	 * @return string[] Multi-dimensional associative list of item data
	 */
	protected function toArray( string $path, \Aimeos\MShop\Common\Item\Type\Iface $item, bool $copy = false )
	{
		$key = str_replace( '/', '.', $path );
		$data = $item->toArray( true );

		if( $copy === true )
		{
			$data[$key . '.type.code'] = $data[$key . '.type.code'] . '_' . substr( md5( microtime( true ) ), -5 );
			$data[$key . '.type.id'] = '';
		}

		return $data;
	}
}

aimeos / ai-admin-jqadm

Push — master ( 6ab2f3...c0a629 )

Base::batchBase() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
