Magento 2

The use of function is_readable() is discouraged in Magento2

Today I was working on method which is responsible to read information of an uploaded file. I came across the same problem I had in my previous blog post ( The use of function filectime() / filemtime() is discouraged in Magento2 ).

154 | WARNING | The use of function is_readable() is discouraged

1	154 \| WARNING \| The use of function is_readable() is discouraged

This time it was able to get rid of the warning quickly, because \Magento\Framework\Filesystem\Driver\File was already injected in my constructor.

protected $driverFile;
...
public function __construct(
    ...
    \Magento\Framework\Filesystem\Driver\File $driverFile,
    ...
) {
    $this->driverFile = $driverFile;
    ...
    parent::__construct($context);
}

protected $driverFile;

...

public function __construct(

...

\Magento\Framework\Filesystem\Driver\File $driverFile,

...

) {

$this->driverFile = $driverFile;

...

parent::__construct($context);

}

I simply replaced is_readable with the below condition.

if ($this->driverFile->isReadable(...)) {

}

if ($this->driverFile->isReadable(...)) {

}

That’s it. Check my blog post about Working with files and folders in Magento2 for more information.

The use of function filectime() / filemtime() is discouraged in Magento2

The problem I had today was located in a helper ( [Namespace]\[Module]\Helper\FileSystem ) which I have created for some basic filesystem operations. The below message was the result of Magento’s EQP which I use before I commit any code.

 68 | WARNING | The use of function filectime() is discouraged
 69 | WARNING | The use of function filemtime() is discouraged

1 2	68 \| WARNING \| The use of function filectime() is discouraged 69 \| WARNING \| The use of function filemtime() is discouraged

The warning message basically means, I should find another way to get the creation and modification time of a file because of Magento’s coding standards. I have done that a couple of times already and would like to share my solution this time. First you have to pass \Magento\Framework\Filesystem\Driver\File in your existing constructor or create a new one.

protected $driverFile;
...
public function __construct(
    ...
    \Magento\Framework\Filesystem\Driver\File $driverFile,
    ...
) {
    $this->driverFile = $driverFile;
    ...
    parent::__construct($context);
}

protected $driverFile;

...

public function __construct(

...

\Magento\Framework\Filesystem\Driver\File $driverFile,

...

) {

$this->driverFile = $driverFile;

...

parent::__construct($context);

}

Once you have re-compiled your code, you have access to the file stats as follows.

$file = '/absolute/path/to/your/file.extension';
$fileData = $this->driverFile->stat($file);

1 2	$file = '/absolute/path/to/your/file.extension'; $fileData = $this->driverFile->stat($file);

Beside ctime and mtime the array $fileData should have other file information like size, atime, uid and gid.

UI Components and searchResultToOutput in Magento2

Today I had to fix the following issue in a custom module. The error appeared on the UI Component list view.

Fatal error: Method Magento\Ui\TemplateEngine\Xhtml\Result::__toString() must not throw an exception, caught TypeError: Argument 1 passed to Magento\Framework\View\Element\UiComponent\DataProvider\DataProvider::searchResultToOutput() must implement interface Magento\Framework\Api\Search\SearchResultInterface, instance of [Namespace]\[Module]\Model\ResourceModel\Team\Collection given, called in

Fatal error: Method Magento\Ui\TemplateEngine\Xhtml\Result::__toString() must not throw an exception, caught TypeError: Argument 1 passed to Magento\Framework\View\Element\UiComponent\DataProvider\DataProvider::searchResultToOutput() must implement interface Magento\Framework\Api\Search\SearchResultInterface, instance of [Namespace]\[Module]\Model\ResourceModel\Team\Collection given, called in

I found the reason of the problem in the di.xml file. All what was missing was the following virtualType node. After adding this and re-compiling the code, the list view was fixed.

<virtualType name="[Namespace]\[Module]\Model\ResourceModel\Team\Collection" type="Magento\Framework\View\Element\UiComponent\DataProvider\SearchResult">
    <arguments>
        <argument name="mainTable" xsi:type="string">[namespace]_[module]_team</argument>
        <argument name="resourceModel" xsi:type="string">[Namespace]\[Module]\Model\ResourceModel\Team</argument>
    </arguments>
</virtualType>

<argument name="mainTable" xsi:type="string">[namespace]_[module]_team</argument>

<argument name="resourceModel" xsi:type="string">[Namespace]\[Module]\Model\ResourceModel\Team</argument>

</arguments>

</virtualType>

UI Component Listing And Not registered handle in Magento2

Today I created a new listing for a custom module, but unfortunately all what I got was the error message below.

Not registered handle [namespace]_[module]_team_index_data_source

1	Not registered handle [namespace]_[module]_team_index_data_source

After digging around for few minutes I noticed the above handler was actually missing in the di.xml file. I simply added the following collections argument and re-compiled the code.

<type name="Magento\Framework\View\Element\UiComponent\DataProvider\CollectionFactory">
    <arguments>
        <argument name="collections" xsi:type="array">
            ...
            <item name="[namespace]_[module]_team_index_data_source" xsi:type="string">[Namespace]\[Module]\Model\ResourceModel\Team\Collection</item>
            ...
        </argument>
    </arguments>
</type>

...

<item name="[namespace]_[module]_team_index_data_source" xsi:type="string">[Namespace]\[Module]\Model\ResourceModel\Team\Collection</item>

...

</argument>

</arguments>

</type>

All good!

The requested component (“settings”) is not found. Before using, you must add the implementation.

I tried to implement a simple field validation for a checkbox Apply Special Price which I needed on the Catalog > Product > Edit page. Unfortunately my first attempt below didn’t work and broke the whole grid table.

The requested component ("settings") is not found. Before using, you must add the implementation.

1	The requested component ("settings") is not found. Before using, you must add the implementation.

Here is how I have defined the field apply_special_price in category_form.xml based on different stackoverflow posts.

<field name="apply_special_price">
    <argument name="data" xsi:type="array">
        <item name="config" xsi:type="array">
            ....
        </item>
    </argument>
    <settings>
        <validation>
            <rule name="required-entry" xsi:type="boolean">false</rule>
        </validation>
        <dataType>boolean</dataType>
    </settings>
    <formElements>
        <checkbox>
            <settings>
                <valueMap>
                    <map name="false" xsi:type="string">0</map>
                    <map name="true" xsi:type="string">1</map>
                </valueMap>
                <prefer>toggle</prefer>
            </settings>
        </checkbox>
    </formElements>
</field>

....

</item>

</argument>

<rule name="required-entry" xsi:type="boolean">false</rule>

</validation>

<dataType>boolean</dataType>

</settings>

</valueMap>

<prefer>toggle</prefer>

</settings>

</checkbox>

</formElements>

</field>

As I said, it didn’t work at all. So, I kept researching and found a solution which allowed me to implement the validation rule without the nodes <settings> and <formElements> inside of <field>.

<field name="apply_special_price">
    <argument name="data" xsi:type="array">
        <item name="config" xsi:type="array">
            <item name="dataType" xsi:type="string">boolean</item>
            <item name="formElement" xsi:type="string">checkbox</item>
            <item name="source" xsi:type="string">category</item>
            <item name="label" xsi:type="string" translate="true">Apply Special Price</item>
            <item name="sortOrder" xsi:type="number">10</item>
            
            <item name="default" xsi:type="number">0</item>
            <item name="prefer" xsi:type="string">toggle</item>
            <item name="validation" xsi:type="array">
                <item name="required-entry" xsi:type="boolean">false</item>
            </item>
            <item name="valueMap" xsi:type="array">
                <item name="true" xsi:type="string">1</item>
                <item name="false" xsi:type="string">0</item>
            </item>
        </item>
    </argument>
</field>

<item name="dataType" xsi:type="string">boolean</item>

<item name="formElement" xsi:type="string">checkbox</item>

<item name="source" xsi:type="string">category</item>

<item name="label" xsi:type="string" translate="true">Apply Special Price</item>

<item name="prefer" xsi:type="string">toggle</item>

<item name="required-entry" xsi:type="boolean">false</item>

</item>

</item>

</argument>

</field>

Basically, everything has to be defined inside of config otherwise the XML for your custom UI component will be invalid. The section validation allows you to define filters for pretty much every use case. The example below sets a field as mandatory and detects white spaces. Beside that it will make sure the value matches a specific regex pattern.

<item name="validation" xsi:type="array">
    <item name="required-entry" xsi:type="boolean">false</item>
    <item name="no-whitespace" xsi:type="boolean">true</item>
    <item name="validate-pattern" xsi:type="string">/^[a-z][a-z0-9_.-]$/i</item>
</item>

<item name="required-entry" xsi:type="boolean">false</item>

</item>

More validation options are available out-of-the-box.

min_text_length
max_text_length
max-words
min-words
range-words
letters-with-basic-punc
alphanumeric
letters-only
no-whitespace
zip-range
integer
vinUS
dateITA
dateNL
time
time12h
phoneUS
phoneUK
mobileUK
stripped-min-length
email2
url2
credit-card-types
ipv4
ipv6
pattern
validate-no-html-tags
validate-select
validate-no-empty
validate-alphanum-with-spaces
validate-data
validate-street
validate-phoneStrict
validate-phoneLax
validate-fax
validate-email
validate-emailSender
validate-password
validate-admin-password
validate-url
validate-clean-url
validate-xml-identifier
validate-ssn
validate-zip-us
validate-date-au
validate-currency-dollar
validate-not-negative-number
validate-zero-or-greater
validate-greater-than-zero
validate-css-length
validate-number
validate-number-range
validate-digits
validate-digits-range
validate-range
validate-alpha
validate-code
validate-alphanum
validate-date
validate-identifier
validate-zip-international
validate-state
less-than-equals-to
greater-than-equals-to
validate-emails
validate-cc-number
validate-cc-ukss
required-entry
checked
not-negative-amount
validate-per-page-value-list
validate-new-password
validate-item-quantity
equalTo

min_text_length

max_text_length

max-words

min-words

range-words

letters-with-basic-punc

alphanumeric

letters-only

no-whitespace

zip-range

integer

vinUS

dateITA

dateNL

time

time12h

phoneUS

phoneUK

mobileUK

stripped-min-length

email2

url2

credit-card-types

ipv4

ipv6

pattern

validate-no-html-tags

validate-select

validate-no-empty

validate-alphanum-with-spaces

validate-data

validate-street

validate-phoneStrict

validate-phoneLax

validate-fax

validate-email

validate-emailSender

validate-password

validate-admin-password

validate-url

validate-clean-url

validate-xml-identifier

validate-ssn

validate-zip-us

validate-date-au

validate-currency-dollar

validate-not-negative-number

validate-zero-or-greater

validate-greater-than-zero

validate-css-length

validate-number

validate-number-range

validate-digits

validate-digits-range

validate-range

validate-alpha

validate-code

validate-alphanum

validate-date

validate-identifier

validate-zip-international

validate-state

less-than-equals-to

greater-than-equals-to

validate-emails

validate-cc-number

validate-cc-ukss

required-entry

checked

not-negative-amount

validate-per-page-value-list

validate-new-password

validate-item-quantity

equalTo

Update composer.lock without updating code

Recently I had to fix a broken composer.lock but without actually updating code. I have found the composer option ” nothing ” which updates the composer.lock file only.

$ composer update nothing

1	$ composer update nothing

Once the command ran successfully, you should see a line ” Writing lock file ” in the output.

$ composer update nothing
Loading composer repositories with package information
Updating dependencies (including require-dev)
Nothing to install or update
Writing lock file
Generating autoload files

$ composer update nothing

Loading composer repositories with package information

Updating dependencies (including require-dev)

Nothing to install or update

Writing lock file

Generating autoload files

If you have issues with dependencies you can update the composer.lock file with –ignore-platform-reqs.

$ composer update nothing --ignore-platform-reqs

1	$ composer update nothing --ignore-platform-reqs

How to Install and Setup Beeketing in Magento2

Beeketing is a marketing automation platform that helps to increase conversion rate and boost revenue in Magento automatically. Beeketing offers a bunch of apps which you can easily enabled via Magento backend. Here is how you can get started with Beeketing.

Go to your Magento2 document root and install Beeketing without updating other packages.

$ composer require beeketing/magento-beeketing --no-update

1	$ composer require beeketing/magento-beeketing --no-update

Wait until the packages beeketing/magento-common and beeketing/magento-beeketing and are installed.

- Installing beeketing/magento-common (v1.1.2): Downloading (100%)
- Installing beeketing/magento-beeketing (v1.0.2): Downloading (100%)

1 2	- Installing beeketing/magento-common (v1.1.2): Downloading (100%) - Installing beeketing/magento-beeketing (v1.0.2): Downloading (100%)

After that re-compile your code and clear all caches. Here is how I usually do it.

chmod u+x bin/magento

bin/magento setup:upgrade

rm -rf ./var/cache/*
rm -rf ./var/generation/*
rm -rf ./pub/static/*
rm -rf ./var/view_preprocessed/*

touch ./pub/static/deployed_version.txt

php -d memory_limit=512M bin/magento setup:di:compile
php -d memory_limit=512M bin/magento setup:static-content:deploy -f
php -d memory_limit=512M bin/magento -vv setup:static-content:deploy en_US

chmod 777 ./app/etc
chmod 644 ./app/etc/*.xml
chown -R www.www .

bin/magento maintenance:disable
chmod u+x bin/magento
bin/magento cache:flush

chmod u+x bin/magento

bin/magento setup:upgrade

rm -rf ./var/cache/*

rm -rf ./var/generation/*

rm -rf ./pub/static/*

rm -rf ./var/view_preprocessed/*

touch ./pub/static/deployed_version.txt

php -d memory_limit=512M bin/magento setup:di:compile

php -d memory_limit=512M bin/magento setup:static-content:deploy -f

php -d memory_limit=512M bin/magento -vv setup:static-content:deploy en_US

chmod 777 ./app/etc

chmod 644 ./app/etc/*.xml

chown -R www.www .

bin/magento maintenance:disable

chmod u+x bin/magento

bin/magento cache:flush

Once the module is installed and enabled, you will see a new menu item BEEKETING in the Magento admin panel sidebar. On this page you have to connect Beeketing with your Magento store. Click on LET’S CONNECT and follow the instructions.

In the next step you have to Sign Up or Login with your existing Beeketing account. Once you are connected, you should see a list of Free and Premium apps, which you can enable via Install app.

As soon as a app is enabled, you should see the changes in the front-end right away.

Settings and statistics for each app can be found in the Beeketing dashboard.

From here I recommend you to checkout http://support.beeketing.com/support/solutions and read how to configure these apps.

Missing required argument $name of Xtento\ProductExport\Logger\Logger.

If you are using Xtento in combination with an automated product importer, you may have seen the following error before.

Missing required argument $name of Xtento\ProductExport\Logger\Logger.

1	Missing required argument $name of Xtento\ProductExport\Logger\Logger.

The error message appears right after saving a product. The reason is that, at least one of your products in Products > Catalog has no Name. To fix this, you can update the name manually via MySQL queries or simply delete the products and import again correctly.

Bulk Update Customizable Product Options in Magento2

Today I had to bulk-update the Price and Max Characters in the tab Customizable Options for hundreds of simple products based on the title.

I knew that it could be done programmatically but I figured out that it can be done just by updating the table catalog_product_option and catalog_product_option_price. First I got a comma separated list of option_id’s based on a specific title.

SELECT GROUP_CONCAT(option_id SEPARATOR ",") AS option_ids FROM catalog_product_option_title WHERE title = 'Some Message';

1	SELECT GROUP_CONCAT(option_id SEPARATOR ",") AS option_ids FROM catalog_product_option_title WHERE title = 'Some Message';

277,281,284,286,289,292,293,294,295

1	277,281,284,286,289,292,293,294,295

With the comma separated list I was able to update the value of the Price and Max Characters as follows.

1. Price

UPDATE catalog_product_option_price SET price = 5.000 WHERE option_id IN (277,281,284,286,289,292,293,294,295);

1	UPDATE catalog_product_option_price SET price = 5.000 WHERE option_id IN (277,281,284,286,289,292,293,294,295);

2. Max Characters

UPDATE catalog_product_option SET max_characters = 300 WHERE option_id IN (277,281,284,286,289,292,293,294,295);

1	UPDATE catalog_product_option SET max_characters = 300 WHERE option_id IN (277,281,284,286,289,292,293,294,295);

Possible that you have to flush the cache ( php/magento cache:flush ) and re-index everything ( php/magento indexer:reindex ) to see the results.

Category “Default Category/abc/def/” has not been created. URL key for specified store already exists in Magento2

A new day, a new problem. While importing new products in Magento 2.1.2 via System > Data Transfer > Import something was causing the following error message.

1. Category "Default Category/abc/def/" has not been created. URL key for specified store already exists. in row(s): 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

1	1. Category "Default Category/abc/def/" has not been created. URL key for specified store already exists. in row(s): 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

The CSV file was 100% correct, which was making it difficult to figure out why it is causing the error. I ran few more test imports and noticed that the main category actually had an empty space at the end, which I believe was causing the whole problem.

The import ran through without any errors after removing the empty space. However, before I also removed all related URL rewrites as follows. Not sure if this was actually necessary.

mysql> DELETE FROM url_rewrite WHERE entity_type = 'category' AND request_path like '%abc/def/%';
Query OK, 6 rows affected (0.01 sec)

1 2	mysql> DELETE FROM url_rewrite WHERE entity_type = 'category' AND request_path like '%abc/def/%'; Query OK, 6 rows affected (0.01 sec)

After that I rebuilt the re-write table with https://github.com/olegkoval/magento2-regenerate_url_rewrites because for some reason the importer didn’t create the rewrite URLs.

$ php bin/magento ok:urlrewrites:regenerate
Regenerating of Url rewrites:

[Store ID: 0, Store View code: admin]:....................
....................
....................
....................
....................
....................
....................
....................
....................
....................
................URL key for specified store already exists.
....
..

$ php bin/magento ok:urlrewrites:regenerate

Regenerating of Url rewrites:

[Store ID: 0, Store View code: admin]:....................

....................

................URL key for specified store already exists.

....

After that everything was working as expected.