aimeos / aimeos-symfony

Controller/AdminController.php

Doc Comments +2 added lines, -2 removed lines

@@ -26,7 +26,7 @@ 
 	 * Returns the initial HTML view for the admin interface.
 	 *
 	 * @param Request $request Symfony request object
-	 * @return Response Generated HTML page for the admin interface
+	 * @return \Symfony\Component\HttpFoundation\Response Generated HTML page for the admin interface
 	 */
 	public function indexAction( Request $request )
 	{
@@ -58,7 +58,7 @@ 
 	/**
 	 * Checks if the used is authenticated and has the admin role
 	 *
-	 * @param array $roles List of role names where at least one must match
+	 * @param string[] $roles List of role names where at least one must match
 	 * @return boolean True if authenticated and is admin, false if not
 	 */
 	protected function hasRole( array $roles )

Spacing +16 added lines, -16 removed lines

@@ -28,30 +28,30 @@ 
 	 * @param Request $request Symfony request object
 	 * @return Response Generated HTML page for the admin interface
 	 */
-	public function indexAction( Request $request )
+	public function indexAction(Request $request)
 	{
-		if( $this->hasRole( ['ROLE_ADMIN'] ) )
+		if ($this->hasRole(['ROLE_ADMIN']))
 		{
-			$context = $this->get( 'aimeos_context' )->get( false );
-			$siteManager = \Aimeos\MShop\Factory::createManager( $context, 'locale/site' );
-			$siteItem = $siteManager->getItem( $this->getUser()->getSiteId() );
+			$context = $this->get('aimeos_context')->get(false);
+			$siteManager = \Aimeos\MShop\Factory::createManager($context, 'locale/site');
+			$siteItem = $siteManager->getItem($this->getUser()->getSiteId());
 
-			$params = array( 'site' => $siteItem->getCode(), 'resource' => 'dashboard' );
-			return $this->redirect( $this->generateUrl( 'aimeos_shop_jqadm_search', $params ) );
+			$params = array('site' => $siteItem->getCode(), 'resource' => 'dashboard');
+			return $this->redirect($this->generateUrl('aimeos_shop_jqadm_search', $params));
 		}
 
 
-		$param = array( 'error' => '', 'username' => '' );
+		$param = array('error' => '', 'username' => '');
 
-		if( $this->has( 'security.authentication_utils' ) )
+		if ($this->has('security.authentication_utils'))
 		{
-			$auth = $this->get( 'security.authentication_utils' );
+			$auth = $this->get('security.authentication_utils');
 
 			$param['error'] = $auth->getLastAuthenticationError();
 			$param['username'] = $auth->getLastUsername();
 		}
 
-		return $this->render( 'AimeosShopBundle:Admin:index.html.twig', $param );
+		return $this->render('AimeosShopBundle:Admin:index.html.twig', $param);
 	}
 
 
@@ -61,15 +61,15 @@ 
 	 * @param array $roles List of role names where at least one must match
 	 * @return boolean True if authenticated and is admin, false if not
 	 */
-	protected function hasRole( array $roles )
+	protected function hasRole(array $roles)
 	{
-		if( $this->has( 'security.authorization_checker' ) && $this->get( 'security.token_storage' )->getToken() )
+		if ($this->has('security.authorization_checker') && $this->get('security.token_storage')->getToken())
 		{
-			$checker = $this->get( 'security.authorization_checker' );
+			$checker = $this->get('security.authorization_checker');
 
-			foreach( $roles as $role )
+			foreach ($roles as $role)
 			{
-				if( $checker->isGranted( $role ) ) {
+				if ($checker->isGranted($role)) {
 					return true;
 				}
 			}

Command/AccountCommand.php

Spacing +67 added lines, -67 removed lines

@@ -29,13 +29,13 @@ 
 	 */
 	protected function configure()
 	{
-		$this->setName( 'aimeos:account');
-		$this->setDescription( 'Creates new (admin) accounts' );
-		$this->addArgument( 'email', InputArgument::REQUIRED, 'E-mail address of the account that should be created' );
-		$this->addArgument( 'site', InputArgument::OPTIONAL, 'Site codes to create accounts for like "default"', 'default' );
-		$this->addOption( 'password', null, InputOption::VALUE_REQUIRED, 'Optional password for the account (will ask for if not given)' );
-		$this->addOption( 'admin', null, InputOption::VALUE_NONE, 'If account should have administrator privileges' );
-		$this->addOption( 'editor', null, InputOption::VALUE_NONE, 'If account should have limited editor privileges' );
+		$this->setName('aimeos:account');
+		$this->setDescription('Creates new (admin) accounts');
+		$this->addArgument('email', InputArgument::REQUIRED, 'E-mail address of the account that should be created');
+		$this->addArgument('site', InputArgument::OPTIONAL, 'Site codes to create accounts for like "default"', 'default');
+		$this->addOption('password', null, InputOption::VALUE_REQUIRED, 'Optional password for the account (will ask for if not given)');
+		$this->addOption('admin', null, InputOption::VALUE_NONE, 'If account should have administrator privileges');
+		$this->addOption('editor', null, InputOption::VALUE_NONE, 'If account should have limited editor privileges');
 	}
 
 
@@ -45,33 +45,33 @@ 
 	 * @param InputInterface $input Input object
 	 * @param OutputInterface $output Output object
 	 */
-	protected function execute( InputInterface $input, OutputInterface $output )
+	protected function execute(InputInterface $input, OutputInterface $output)
 	{
-		$code = $input->getArgument( 'email' );
-		if( ( $password = $input->getOption( 'password' ) ) === null )
+		$code = $input->getArgument('email');
+		if (($password = $input->getOption('password')) === null)
 		{
-			$helper = $this->getHelper( 'question' );
-			$question = new Question( 'Password' );
-			$question->setHidden( true );
+			$helper = $this->getHelper('question');
+			$question = new Question('Password');
+			$question->setHidden(true);
 
-			$password = $helper->ask( $input, $output, $question );
+			$password = $helper->ask($input, $output, $question);
 		}
 
-		$context = $this->getContainer()->get( 'aimeos_context' )->get( false, 'command' );
-		$context->setEditor( 'aimeos:account' );
+		$context = $this->getContainer()->get('aimeos_context')->get(false, 'command');
+		$context->setEditor('aimeos:account');
 
-		$localeManager = \Aimeos\MShop\Locale\Manager\Factory::createManager( $context );
-		$localeItem = $localeManager->bootstrap( $input->getArgument( 'site' ), '', '', false );
-		$context->setLocale( $localeItem );
+		$localeManager = \Aimeos\MShop\Locale\Manager\Factory::createManager($context);
+		$localeItem = $localeManager->bootstrap($input->getArgument('site'), '', '', false);
+		$context->setLocale($localeItem);
 
-		$user = $this->createCustomerItem( $context, $code, $password );
+		$user = $this->createCustomerItem($context, $code, $password);
 
-		if( $input->getOption( 'admin' ) ) {
-			$this->addGroup( $input, $output, $context, $user, 'admin' );
+		if ($input->getOption('admin')) {
+			$this->addGroup($input, $output, $context, $user, 'admin');
 		}
 
-		if( $input->getOption( 'editor' ) ) {
-			$this->addGroup( $input, $output, $context, $user, 'editor' );
+		if ($input->getOption('editor')) {
+			$this->addGroup($input, $output, $context, $user, 'editor');
 		}
 	}
 
@@ -85,24 +85,24 @@ 
 	 * @param \Aimeos\MShop\Customer\Item\Iface $user Aimeos customer object
 	 * @param string $group Unique customer group code
 	 */
-	protected function addGroup( InputInterface $input, OutputInterface $output,
-		\Aimeos\MShop\Context\Item\Iface $context, \Aimeos\MShop\Customer\Item\Iface $user, $group )
+	protected function addGroup(InputInterface $input, OutputInterface $output,
+		\Aimeos\MShop\Context\Item\Iface $context, \Aimeos\MShop\Customer\Item\Iface $user, $group)
 	{
-		$output->writeln( sprintf( 'Add "%1$s" group to user "%2$s" for sites', $group, $user->getCode() ) );
+		$output->writeln(sprintf('Add "%1$s" group to user "%2$s" for sites', $group, $user->getCode()));
 
-		$localeManager = \Aimeos\MShop\Locale\Manager\Factory::createManager( $context );
+		$localeManager = \Aimeos\MShop\Locale\Manager\Factory::createManager($context);
 
-		foreach( $this->getSiteItems( $context, $input ) as $siteItem )
+		foreach ($this->getSiteItems($context, $input) as $siteItem)
 		{
-			$localeItem = $localeManager->bootstrap( $siteItem->getCode(), '', '', false );
+			$localeItem = $localeManager->bootstrap($siteItem->getCode(), '', '', false);
 
 			$lcontext = clone $context;
-			$lcontext->setLocale( $localeItem );
+			$lcontext->setLocale($localeItem);
 
-			$output->writeln( '- ' . $siteItem->getCode() );
+			$output->writeln('- '.$siteItem->getCode());
 
-			$groupItem = $this->getGroupItem( $lcontext, $group );
-			$this->addListItem( $lcontext, $user->getId(), $groupItem->getId() );
+			$groupItem = $this->getGroupItem($lcontext, $group);
+			$this->addListItem($lcontext, $user->getId(), $groupItem->getId());
 		}
 	}
 
@@ -114,31 +114,31 @@ 
 	 * @param string $userid Unique user ID
 	 * @param string $groupid Unique group ID
 	 */
-	protected function addListItem( \Aimeos\MShop\Context\Item\Iface $context, $userid, $groupid )
+	protected function addListItem(\Aimeos\MShop\Context\Item\Iface $context, $userid, $groupid)
 	{
-		$manager = \Aimeos\MShop\Customer\Manager\Factory::createManager( $context )->getSubmanager( 'lists' );
-		$typeid = $manager->getSubmanager( 'type' )->findItem( 'default', array(), 'customer/group' )->getId();
+		$manager = \Aimeos\MShop\Customer\Manager\Factory::createManager($context)->getSubmanager('lists');
+		$typeid = $manager->getSubmanager('type')->findItem('default', array(), 'customer/group')->getId();
 
 		$search = $manager->createSearch();
 		$expr = array(
-			$search->compare( '==', 'customer.lists.parentid', $userid ),
-			$search->compare( '==', 'customer.lists.refid', $groupid ),
-			$search->compare( '==', 'customer.lists.domain', 'customer/group' ),
-			$search->compare( '==', 'customer.lists.typeid', $typeid ),
+			$search->compare('==', 'customer.lists.parentid', $userid),
+			$search->compare('==', 'customer.lists.refid', $groupid),
+			$search->compare('==', 'customer.lists.domain', 'customer/group'),
+			$search->compare('==', 'customer.lists.typeid', $typeid),
 		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-		$search->setSlice( 0, 1 );
+		$search->setConditions($search->combine('&&', $expr));
+		$search->setSlice(0, 1);
 
-		if( count( $manager->searchItems( $search ) ) === 0 )
+		if (count($manager->searchItems($search)) === 0)
 		{
 			$item = $manager->createItem();
-			$item->setDomain( 'customer/group' );
-			$item->setParentId( $userid );
-			$item->setTypeId( $typeid );
-			$item->setRefId( $groupid );
-			$item->setStatus( 1 );
+			$item->setDomain('customer/group');
+			$item->setParentId($userid);
+			$item->setTypeId($typeid);
+			$item->setRefId($groupid);
+			$item->setStatus(1);
 
-			$manager->saveItem( $item, false );
+			$manager->saveItem($item, false);
 		}
 	}
 
@@ -153,23 +153,23 @@ 
 	 * @param string $password New user password
 	 * @return \Aimeos\MShop\Customer\Item\Iface Aimeos customer item object
 	 */
-	protected function createCustomerItem( \Aimeos\MShop\Context\Item\Iface $context, $email, $password )
+	protected function createCustomerItem(\Aimeos\MShop\Context\Item\Iface $context, $email, $password)
 	{
-		$manager = \Aimeos\MShop\Factory::createManager( $context, 'customer' );
+		$manager = \Aimeos\MShop\Factory::createManager($context, 'customer');
 
 		try {
-			$item = $manager->findItem( $email );
-		} catch( \Aimeos\MShop\Exception $e ) {
+			$item = $manager->findItem($email);
+		} catch (\Aimeos\MShop\Exception $e) {
 			$item = $manager->createItem();
 		}
 
-		$item->setCode( $email );
-		$item->setLabel( $email );
-		$item->getPaymentAddress()->setEmail( $email );
-		$item->setPassword( $password );
-		$item->setStatus( 1 );
+		$item->setCode($email);
+		$item->setLabel($email);
+		$item->getPaymentAddress()->setEmail($email);
+		$item->setPassword($password);
+		$item->setStatus(1);
 
-		$manager->saveItem( $item );
+		$manager->saveItem($item);
 
 		return $item;
 	}
@@ -182,21 +182,21 @@ 
 	 * @param string $code Unique customer group code
 	 * @return \Aimeos\MShop\Customer\Item\Group\Iface Aimeos customer group item object
 	 */
-	protected function getGroupItem( \Aimeos\MShop\Context\Item\Iface $context, $code )
+	protected function getGroupItem(\Aimeos\MShop\Context\Item\Iface $context, $code)
 	{
-		$manager = \Aimeos\MShop\Customer\Manager\Factory::createManager( $context )->getSubmanager( 'group' );
+		$manager = \Aimeos\MShop\Customer\Manager\Factory::createManager($context)->getSubmanager('group');
 
 		try
 		{
-			$item = $manager->findItem( $code );
+			$item = $manager->findItem($code);
 		}
-		catch( \Aimeos\MShop\Exception $e )
+		catch (\Aimeos\MShop\Exception $e)
 		{
 			$item = $manager->createItem();
-			$item->setLabel( $code );
-			$item->setCode( $code );
+			$item->setLabel($code);
+			$item->setCode($code);
 
-			$manager->saveItem( $item );
+			$manager->saveItem($item);
 		}
 
 		return $item;

Controller/JqadmController.php

Spacing +49 added lines, -49 removed lines

@@ -29,35 +29,35 @@ 
 	 * @param $type File type, i.e. "css" or "js"
 	 * @return Response Response object
 	 */
-	public function fileAction( $type )
+	public function fileAction($type)
 	{
 		$contents = '';
 		$files = array();
-		$aimeos = $this->get( 'aimeos' )->get();
+		$aimeos = $this->get('aimeos')->get();
 
-		foreach( $aimeos->getCustomPaths( 'admin/jqadm' ) as $base => $paths )
+		foreach ($aimeos->getCustomPaths('admin/jqadm') as $base => $paths)
 		{
-			foreach( $paths as $path )
+			foreach ($paths as $path)
 			{
-				$jsbAbsPath = $base . '/' . $path;
-				$jsb2 = new \Aimeos\MW\Jsb2\Standard( $jsbAbsPath, dirname( $jsbAbsPath ) );
-				$files = array_merge( $files, $jsb2->getFiles( $type ) );
+				$jsbAbsPath = $base.'/'.$path;
+				$jsb2 = new \Aimeos\MW\Jsb2\Standard($jsbAbsPath, dirname($jsbAbsPath));
+				$files = array_merge($files, $jsb2->getFiles($type));
 			}
 		}
 
-		foreach( $files as $file )
+		foreach ($files as $file)
 		{
-			if( ( $content = file_get_contents( $file ) ) !== false ) {
+			if (($content = file_get_contents($file)) !== false) {
 				$contents .= $content;
 			}
 		}
 
-		$response = new Response( $contents );
+		$response = new Response($contents);
 
-		if( $type === 'js' ) {
-			$response->headers->set( 'Content-Type', 'application/javascript' );
-		} elseif( $type === 'css' ) {
-			$response->headers->set( 'Content-Type', 'text/css' );
+		if ($type === 'js') {
+			$response->headers->set('Content-Type', 'application/javascript');
+		} elseif ($type === 'css') {
+			$response->headers->set('Content-Type', 'text/css');
 		}
 
 		return $response;
@@ -72,10 +72,10 @@ 
 	 * @param string $site Unique site code
 	 * @return Response Generated output
 	 */
-	public function copyAction( Request $request, $resource, $site = 'default' )
+	public function copyAction(Request $request, $resource, $site = 'default')
 	{
-		$cntl = $this->createClient( $request, $site, $resource );
-		return $this->getHtml( $cntl->copy() );
+		$cntl = $this->createClient($request, $site, $resource);
+		return $this->getHtml($cntl->copy());
 	}
 
 
@@ -87,10 +87,10 @@ 
 	 * @param string $site Unique site code
 	 * @return Response Generated output
 	 */
-	public function createAction( Request $request, $resource, $site = 'default' )
+	public function createAction(Request $request, $resource, $site = 'default')
 	{
-		$cntl = $this->createClient( $request, $site, $resource );
-		return $this->getHtml( $cntl->create() );
+		$cntl = $this->createClient($request, $site, $resource);
+		return $this->getHtml($cntl->create());
 	}
 
 
@@ -102,17 +102,17 @@ 
 	 * @param string $site Unique site code
 	 * @return Response Generated output
 	 */
-	public function deleteAction( Request $request, $resource, $site = 'default' )
+	public function deleteAction(Request $request, $resource, $site = 'default')
 	{
-		$cntl = $this->createClient( $request, $site, $resource );
+		$cntl = $this->createClient($request, $site, $resource);
 
 		$cntl = $this->createClient();
 
-		if( ( $html = $cntl->delete() ) == '' ) {
+		if (($html = $cntl->delete()) == '') {
 			return $cntl->getView()->response();
 		}
 
-		return $this->getHtml( $html );
+		return $this->getHtml($html);
 	}
 
 
@@ -124,10 +124,10 @@ 
 	 * @param string $site Unique site code
 	 * @return Response Generated output
 	 */
-	public function getAction( Request $request, $resource, $site = 'default' )
+	public function getAction(Request $request, $resource, $site = 'default')
 	{
-		$cntl = $this->createClient( $request, $site, $resource );
-		return $this->getHtml( $cntl->get() );
+		$cntl = $this->createClient($request, $site, $resource);
+		return $this->getHtml($cntl->get());
 	}
 
 
@@ -139,15 +139,15 @@ 
 	 * @param string $site Unique site code
 	 * @return Response Generated output
 	 */
-	public function saveAction( Request $request, $resource, $site = 'default' )
+	public function saveAction(Request $request, $resource, $site = 'default')
 	{
-		$cntl = $this->createClient( $request, $site, $resource );
+		$cntl = $this->createClient($request, $site, $resource);
 
-		if( ( $html = $cntl->save() ) == '' ) {
+		if (($html = $cntl->save()) == '') {
 			return $cntl->getView()->response();
 		}
 
-		return $this->getHtml( $html );
+		return $this->getHtml($html);
 	}
 
 
@@ -159,10 +159,10 @@ 
 	 * @param string $site Unique site code
 	 * @return Response Generated output
 	 */
-	public function searchAction( Request $request, $resource, $site = 'default' )
+	public function searchAction(Request $request, $resource, $site = 'default')
 	{
-		$cntl = $this->createClient( $request, $site, $resource );
-		return $this->getHtml( $cntl->search() );
+		$cntl = $this->createClient($request, $site, $resource);
+		return $this->getHtml($cntl->search());
 	}
 
 
@@ -174,21 +174,21 @@ 
 	 * @param string $resource Resource location, e.g. "product"
 	 * @return \Aimeos\Admin\JQAdm\Iface Context item
 	 */
-	protected function createClient( Request $request, $site, $resource )
+	protected function createClient(Request $request, $site, $resource)
 	{
-		$lang = $request->get( 'lang', 'en' );
+		$lang = $request->get('lang', 'en');
 
-		$aimeos = $this->get( 'aimeos' )->get();
-		$templatePaths = $aimeos->getCustomPaths( 'admin/jqadm/templates' );
+		$aimeos = $this->get('aimeos')->get();
+		$templatePaths = $aimeos->getCustomPaths('admin/jqadm/templates');
 
-		$context = $this->get( 'aimeos_context' )->get( false, 'backend' );
-		$context->setI18n( $this->get( 'aimeos_i18n' )->get( array( $lang, 'en' ) ) );
-		$context->setLocale( $this->get( 'aimeos_locale' )->getBackend( $context, $site ) );
+		$context = $this->get('aimeos_context')->get(false, 'backend');
+		$context->setI18n($this->get('aimeos_i18n')->get(array($lang, 'en')));
+		$context->setLocale($this->get('aimeos_locale')->getBackend($context, $site));
 
-		$view = $this->get( 'aimeos_view' )->create( $context, $templatePaths, $lang );
-		$context->setView( $view );
+		$view = $this->get('aimeos_view')->create($context, $templatePaths, $lang);
+		$context->setView($view);
 
-		return \Aimeos\Admin\JQAdm\Factory::createClient( $context, $templatePaths, $resource )->setAimeos( $aimeos );
+		return \Aimeos\Admin\JQAdm\Factory::createClient($context, $templatePaths, $resource)->setAimeos($aimeos);
 	}
 
 
@@ -198,12 +198,12 @@ 
 	 * @param string $content Content from admin client
 	 * @return Response View for rendering the output
 	 */
-	protected function getHtml( $content )
+	protected function getHtml($content)
 	{
-		$version = $this->get( 'aimeos' )->getVersion();
-		$extnames = implode( ',', $this->get( 'aimeos' )->get()->getExtensions() );
-		$content = str_replace( ['{type}', '{version}', '{extensions}'], ['Symfony', $version, $extnames], $content );
+		$version = $this->get('aimeos')->getVersion();
+		$extnames = implode(',', $this->get('aimeos')->get()->getExtensions());
+		$content = str_replace(['{type}', '{version}', '{extensions}'], ['Symfony', $version, $extnames], $content);
 
-		return $this->render( 'AimeosShopBundle:Jqadm:index.html.twig', array( 'content' => $content ) );
+		return $this->render('AimeosShopBundle:Jqadm:index.html.twig', array('content' => $content));
 	}
 }