DEV Community: Tschallacka

How to persist data between requests for form validation in Magento 2

Tschallacka — Mon, 02 Jan 2023 11:16:59 +0000

The DataPersistorInterface is used to persist data temporarily for later use, such as during a redirect.

It is often used in controllers to store form data in the session so that it can be used to pre-populate a form if there is an error in form submission.

public function execute()
{
    $post = $this->getRequest()->getPostValue();
    $resultRedirect = $this->resultRedirectFactory->create();
    if ($post) {
        $model = $this->contactFactory->create($post);
        try {
            $this->contactRepository->save($model);
            $this->messageManager->addSuccessMessage(__('Your inquiry was submitted and will be responded to as soon as possible. Thank you for contacting us.'));
            $this->dataPersistor->clear('contact_us');
            return $resultRedirect->setPath('contact/index');
        } catch (LocalizedException $e) {
            $this->messageManager->addErrorMessage($e->getMessage());
        } catch (\Exception $e) {
            $this->messageManager->addExceptionMessage($e, __('An error occurred while processing your form. Please try again later.'));
        }

        $this->dataPersistor->set('contact_us', $post);
        return $resultRedirect->setPath('contact/index');
    }
    return $resultRedirect->setPath('contact/index');
}

To use it simple include the Magento\Framework\App\Request\DataPersistorInterface in your __construct()

use Magento\Framework\App\Request\DataPersistorInterface;

class YourClass {

  protected DataPersistorInterface $dataPersistor;

  public function __construct(
     DataPersistorInterface $dataPersistor
  ) {
      $this->dataPersistor = $dataPersistor;
  }
}

Connecting Asana with Intellij/PHPStorm

Tschallacka — Wed, 10 Nov 2021 15:07:44 +0000

Press CTRL + ALT + S or go to File > Settings

Go to Tools > Tasks > Servers and press the small plus icon at the top.

Select Asana in the dropdown menu

In the bottom form fields will appear.

Fill in for Server url: https://app.asana.com/api/1.0

Fill in for project ID the project ID in the url when you look at your dashboard.

https://app.asana.com/0/000_PROJECT_ID_000

Copy and paste that in the Project ID field.

Visit https://app.asana.com/0/my-apps

Click on new Access Token

Enter a handy name for yourself so you know what you're using the token for(for example phpstorm)

Copy the token generated, and store it in a password manager like keepass, for when you need it again.

Copy the access token to the username field. Keep the password field empty

Check the "Use HTTP authentication" checkbox

Click on the "Server Configuration" Tab.

Make sure your tasks lists url is

{serverUrl}/projects/{project_ID}/tasks?workspaces=WORKSPACE_ID

You can retrieve WORKSPACE_ID from https://app.asana.com/api/1.0/users/me and then use the value in gid in the workspaces object.

And your Single Task URL is

{serverUrl}/tasks/{id}

Change the value for id from id to gid

And the value of singleTask-id from data.id to data.gid

And the value of singleTask-issueUrl from to data.permalink_url

Click on Test Connection, and everything should go smoothly.

A new dropdown will appear in the top right, where you can select open task

Opening this window will open a screen with all the asana tasks. You can also browse your tasks via Tools > Tasks & Contents

Apache2 php error.log pretty format

Tschallacka — Fri, 15 Oct 2021 16:53:33 +0000

You're looking through the apache error log and you see this:

[Fri Oct 15 17:58:43.458518 2021] [php7:error] [pid 41144] [client ::1:46744] PHP Fatal error:  Uncaught Error: Call to a member function getStockStatus() on bool in /var/www/example.com.localhost/vendor/magento/module-catalog-inventory/Model/Quote/Item/QuantityValidator.php:157\nStack trace:\n#0 /var/www/example.com.localhost/vendor/magento/module-catalog-inventory/Observer/QuantityValidatorObserver.php(34): Magento\\CatalogInventory\\Model\\Quote\\Item\\QuantityValidator->validate(Object(Magento\\Framework\\Event\\Observer))\n#1 /var/www/example.com.localhost/vendor/magento/framework/Event/Invoker/InvokerDefault.php(88): Magento\\CatalogInventory\\Observer\\QuantityValidatorObserver->execute(Object(Magento\\Framework\\Event\\Observer))\n#2 /var/www/example.com.localhost/vendor/magento/framework/Event/Invoker/InvokerDefault.php(74): Magento\\Framework\\Event\\Invoker\\InvokerDefault->_callObserverMethod(Object(Magento\\CatalogInventory\\Observer\\QuantityValidatorObserver), Object(Magento\\Framework\\Event\\Observer))\n#3 /var/www/example.com.localhost/vendor/magento/module-staging/Model/Event/Manager.php(97): Magento\\Framework\\Event\\Invoke in /var/www/example.com.localhost/vendor/magento/module-catalog-inventory/Model/Quote/Item/QuantityValidator.php on line 157, referer: http://example.com.localhost/run-away-basics-rugzak-15039001.html
[Fri Oct 15 18:12:15.634605 2021] [php7:error] [pid 41145] [client ::1:53320] PHP Fatal error:  Uncaught Error: Call to a member function getStockStatus() on bool in /var/www/example.com.localhost/vendor/magento/module-catalog-inventory/Model/Quote/Item/QuantityValidator.php:157\nStack trace:\n#0 /var/www/example.com.localhost/vendor/magento/module-catalog-inventory/Observer/QuantityValidatorObserver.php(34): Magento\\CatalogInventory\\Model\\Quote\\Item\\QuantityValidator->validate(Object(Magento\\Framework\\Event\\Observer))\n#1 /var/www/example.com.localhost/vendor/magento/framework/Event/Invoker/InvokerDefault.php(88): Magento\\CatalogInventory\\Observer\\QuantityValidatorObserver->execute(Object(Magento\\Framework\\Event\\Observer))\n#2 /var/www/example.com.localhost/vendor/magento/framework/Event/Invoker/InvokerDefault.php(74): Magento\\Framework\\Event\\Invoker\\InvokerDefault->_callObserverMethod(Object(Magento\\CatalogInventory\\Observer\\QuantityValidatorObserver), Object(Magento\\Framework\\Event\\Observer))\n#3 /var/www/example.com.localhost/vendor/magento/module-staging/Model/Event/Manager.php(97): Magento\\Framework\\Event\\Invoke in /var/www/example.com.localhost/vendor/magento/module-catalog-inventory/Model/Quote/Item/QuantityValidator.php on line 157, referer: http://example.com.localhost/run-away-basics-rugzak-15039001.html

Which isn't really handy for debugging

Now if you use the below command in bash, to pretty format the apache 2 error log for php fatal errors, you get a nicer output(in my opinion)

tail -f /var/log/apache2/error.log | grep 'PHP Fatal error' | grep '/var/www/example.com' | sed -u -e 's/\\n/\n/g' | sed -e 's/\.php(\([0-9]*\)):\s/.php:\1 /g'

[Fri Oct 15 17:41:40.026908 2021] [php7:error] [pid 37596] [client ::1:37662] PHP Fatal error:  Uncaught Error: Cannot instantiate interface Magento\\Framework\\App\\Area\\FrontNameResolverInterface in /var/www/example.com.localhost/vendor/magento/framework/ObjectManager/Factory/Dynamic/Developer.php:50
Stack trace:
#0 /var/www/example.com.localhost/vendor/magento/framework/ObjectManager/ObjectManager.php:70 Magento\\Framework\\ObjectManager\\Factory\\Dynamic\\Developer->create('Magento\\\\Framewo...')
#1 /var/www/example.com.localhost/vendor/magento/framework/ObjectManager/Factory/AbstractFactory.php:167 Magento\\Framework\\ObjectManager\\ObjectManager->get('Magento\\\\Framewo...')
#2 /var/www/example.com.localhost/vendor/magento/framework/ObjectManager/Factory/AbstractFactory.php:273 Magento\\Framework\\ObjectManager\\Factory\\AbstractFactory->resolveArgument(Array, 'Magento\\\\Framewo...', NULL, 'front_name_reso...', 'BigBridge\\\\Stock...')
#3 /var/www/example.com.localhost/vendor/magento/framework/ObjectManager/Factory/AbstractFactory.php:236 Magento\\Framework\\ObjectManager\\Factory\\AbstractFactory->getResolvedArgument('BigB in /var/www/example.com.localhost/vendor/magento/framework/ObjectManager/Factory/Dynamic/Developer.php on line 50, referer: http://example.com.localhost/run-away-basics-rugzak-15039001.html
[Fri Oct 15 17:52:10.110658 2021] [php7:error] [pid 39564] [client ::1:43134] PHP Fatal error:  Uncaught Error: Call to a member function getStockStatus() on bool in /var/www/example.com.localhost/vendor/magento/module-catalog-inventory/Model/Quote/Item/QuantityValidator.php:157
Stack trace:
#0 /var/www/example.com.localhost/vendor/magento/module-catalog-inventory/Observer/QuantityValidatorObserver.php:34 Magento\\CatalogInventory\\Model\\Quote\\Item\\QuantityValidator->validate(Object(Magento\\Framework\\Event\\Observer))
#1 /var/www/example.com.localhost/vendor/magento/framework/Event/Invoker/InvokerDefault.php:88 Magento\\CatalogInventory\\Observer\\QuantityValidatorObserver->execute(Object(Magento\\Framework\\Event\\Observer))
#2 /var/www/example.com.localhost/vendor/magento/framework/Event/Invoker/InvokerDefault.php:74 Magento\\Framework\\Event\\Invoker\\InvokerDefault->_callObserverMethod(Object(Magento\\CatalogInventory\\Observer\\QuantityValidatorObserver), Object(Magento\\Framework\\Event\\Observer))
#3 /var/www/example.com.localhost/vendor/magento/module-staging/Model/Event/Manager.php:97 Magento\\Framework\\Event\\Invoke in /var/www/example.com.localhost/vendor/magento/module-catalog-inventory/Model/Quote/Item/QuantityValidator.php on line 157, referer: http://example.com.localhost/run-away-basics-rugzak-15039001.html

Now if you're using phpstorm and you install the plugin Awesome console they'll even become clickable in run output and console output, so you can simply click, go to the correct file and line and debug from there.

Say we add a composer script for easy composer run configuration in php storm, even then the output there is clickable to open the file at line.

    "scripts": {
        "dev-server-log": [
            "tail -f /var/log/apache2/error.log |  grep '/var/www/example.com' | sed -u -e 's/\\\\n/\\n/g' | sed -e 's/\\.php(\\([0-9]*\\)):\\s/.php:\\1 /g' "
        ]
    },

The awesome console plugin isn't perfect, and doesn't always make all links clickable, but every time you don't need to select a line and open the file that way, is time saved.

Happy coding!

How to save a Magento 2 Product Attribute programmatically

Tschallacka — Wed, 23 Jun 2021 07:51:36 +0000

Saving an attribute value from a dropdown value can be hassle, especially when you want to use it in integration tests, but don't know how the ID of an attribute value, but you know the string value, because it's a custom defined attribute and not programmatically.

The tldr code:

/** 
 * @var Magento\Catalog\Model\Product $product 
 * @var Magento\Catalog\Api\ProductRepositoryInterface $productRepository
 */
$product = $productRepository->get('simple', false, null, true);
$product->setData('attribute_code', $value);
$productRepository->save($product);

Now for some longer code, which is the story of what led me to needing this, is simple integration tests with values that are defined by the end user, but needs to be implemented in the code for values(long live real life scenarios)

To save your own attribute values that can be selected I suggest you copy the code from Magento/Catalog/_files/products_with_layered_navigation_attribute.php and modify with the values you need.

To avoid magic strings we'll use a class to hold our constants.

namespace Tschallacka\Example\Attributes;

class Attributes 
{
   const MY_ATTRIBUTE_NAME = 'my_supplier';
}

class Suppliers 
{
   const SUPPLIER_A = 'Supplier a';
   const SUPPLIER_B = 'Supplier B';
   const SUPPLIER_C = 'C Supplier inc.';
}

We make a helper to get the value from the possible dropdown values

namespace Tschallacka\Example\Helper;

use Magento\Eav\Api\AttributeRepositoryInterface;
use Magento\Framework\App\Helper\AbstractHelper;
use Magento\Catalog\Model\Product;
use Magento\Framework\App\Helper\Context;

class AttributeHelper extends AbstractHelper
{
    static $archive = [];

    public function __construct(
        Context $context,
        AttributeRepositoryInterface $attribute_repository
    ) {
        $this->attribute_repository = $attribute_repository;
        parent::__construct($context);
    }

    public function getAttributeValueForStringValue($attribute_code, $search_string)
    {
        $options = $this->getAttributeOptions($attribute_code);
        if(array_key_exists($search_string, $options)) {
            return $options[$search_string];
        }
    }

    public function getAttributeOptions($attribute_code)
    {
        if(!array_key_exists($attribute_code, self::$archive)) {
            self::$archive[$attribute_code] = array_reduce(
                $this->attribute_repository
                ->get(Product::ENTITY, $attribute_code)
                ->getSource()
                ->getAllOptions(false))
            )
            , function ($collector, $attribute) {
                $collector[$attribute['label']] = $attribute['value'];
                return $collector;
            }, []);
        }
        return self::$archive[$attribute_code];
    }
}

Then in the integration test or where else you need it, you can use it as follows in a data fixture(or your own class with the appropriate classes provided by the injection) to save the attribute value.

use PHPUnit\Framework\TestCase;
use Magento\TestFramework\ObjectManager;
use Magento\Catalog\Api\ProductRepositoryInterface;
use Magento\Eav\Api\AttributeRepositoryInterface;
use Tschallacka\Helper\AttributeHelper;
use Tschallacka\Attributes\Attributes;
use Tschallacka\Attributes\Suppliers;

class MyIntegrationTest extends TestCase 
{
    public static function modifySimpleProduct()
    {
        /** @var ObjectManager $objectManager */
        $objectManager = Bootstrap::getObjectManager();
        /** @var ProductRepositoryInterface $productRepository */
        $productRepository = $objectManager->create(ProductRepositoryInterface::class);
        $attributeRepository = $objectManager->create(AttributeRepositoryInterface::class);
        /** @var AttributeHelper $attributeHelper */
        $attributeHelper = $objectManager->create(AttributeHelper::class);
        $option = $attributeHelper->getAttributeValueForStringValue(Attributes::MY_ATTRIBUTE_NAME, Suppliers::SUPPLIER_C);
        /** @var Product $product */
        $product = $productRepository->get('simple', false, null, true);
        $product->setData(Attributes::MY_ATTRIBUTE_NAME, $option);
        $productRepository->save($product);
    }
}