Skip to content

Latest commit

 

History

History
143 lines (121 loc) · 7.53 KB

config-cli-subcommands-compiler.md

File metadata and controls

143 lines (121 loc) · 7.53 KB
layout group subgroup title menu_title menu_node menu_order version github_link redirect_from
default
config-guide
04_CLI
Code compiler
Code compiler
175
2.0
config-guide/cli/config-cli-subcommands-compiler.md
/guides/v1.0/config-guide/cli/config-cli-subcommands-compiler-single.html
/guides/v2.0/config-guide/cli/config-cli-subcommands-compiler-single.html
/guides/v2.0/config-guide/cli/config-cli-subcommands-compiler-multi.html

Overview of code compilation

This section discusses the basics of code compilation.

Code compilation consists of all of the following in no particular order:

  • Application code generation (factories, proxies, and so on)
  • Area configuration aggregation (that is, optimized {% glossarytooltip 2be50595-c5c7-4b9d-911c-3bf2cd3f7beb %}dependency injection{% endglossarytooltip %} configurations per area)
  • Interceptor generation (that is, optimized code generation of interceptors)
  • Interception {% glossarytooltip 0bc9c8bc-de1a-4a06-9c99-a89a29c30645 %}cache{% endglossarytooltip %} generation
  • Repositories code generation (that is, generated code for APIs)
  • Service data attributes generation (that is, generated {% glossarytooltip 55774db9-bf9d-40f3-83db-b10cc5ae3b68 %}extension{% endglossarytooltip %} classes for data objects)

You can find code compilation in classes in the \Magento\Setup\Module\Di\App\Task\Operation {% glossarytooltip 621ef86b-7314-4fbc-a80d-ab7fa45a27cb %}namespace{% endglossarytooltip %}.

First steps

{% include install/first-steps-cli.html %} In addition to the command arguments discussed here, see Common arguments.

Run the single-tenant compiler

Run the command as follows (there are no options): 
magento setup:di:compile

The following message displays to confirm success:

Generated code and dependency injection configuration successfully.

In Magento versions 2.0.5 and earlier, there is a known issue with the single-tenant compiler; it does not currently compile proxies. Therefore, if you're preparing to deploy to production, you must use the multi-tenant compiler.

The issue was resolved in Magento versions 2.0.6 and later.

Run the multi-tenant compiler

Use this command if you have multiple *tenants*, which means more than one independent Magento application. In other words:
  • There is one Magento 2 code base instance
  • There is one database instance per tenant
  • Independent configurations in the {% glossarytooltip 18b930cf-09cc-47c9-a5e5-905f86c43f81 %}Magento Admin{% endglossarytooltip %} per tenant
  • The storefronts are independent of each other

If you do not have multiple tenants, use the single-tenant compiler instead.

Command options:

magento setup:di:compile-multi-tenant [--serializer="{serialize|igbinary}"] [--extra-classes-file="<path>"] [--generation="<path and 
filename>"] [--di="<path and filename>"] [--exclude-pattern="<regex>"]

The following table discusses the meanings of this command's parameters and values.

<tr>
	<td><p>--serializer</p></td>
	<td><p>Specify either <code>serialize</code> or <a href="https://github.com/phadej/igbinary" target="_blank">igbinary</a>. Default is <code>serialize</code>.</p></td>
	<td><p>No</p></td>
</tr>
<tr>
	<td><p>--extra-classes-file</p></td>
	<td><p>Specify the absolute file system path to proxies and factories that are not declared in the dependency injection or code..</p></td>
	<td><p>No</p></td>
</tr>
<tr>
	<td><p>--generation</p></td>
	<td><p>Absolute file system path to a directory for generated classes. Default is <code>&lt;your Magento install dir>/var/generation</code></p></td>
	<td><p>No</p></td>
</tr>
<tr>
	<td><p>--di</p></td>
	<td><p>Absolute file system path to a directory to generate the object manager configuration. Default is <code>&lt;your Magento install dir>/var/di</code></p></td>
	<td><p>No</p></td>
</tr>
<tr>
	<td><p>--exclude-pattern</p></td>
	<td><p>Regular expression that enables you to exclude paths from compilation. Default is <code>#[\\/]m1[\\/]#i)</code></p></td>
	<td><p>No</p></td>
</tr>

</tbody>
Parameter Value Required?

For example, to run the compiler and specify the igbinary serializer:

magento setup:di:compile-multi-tenant --serializer=igbinary

Messages similar to the following display:

Generated classes:
    Magento\Rss\Controller\Adminhtml\Feed\Interceptor
    Magento\Quote\Model\Quote\Config\Interceptor
    Magento\Checkout\Block\Cart\Shipping\Interceptor
    Magento\Framework\View\Layout\Interceptor
    Magento\Integration\Service\V1\Integration\Interceptor
    Magento\Catalog\Block\Product\Compare\ListCompare\Interceptor
    Magento\Framework\View\TemplateEngineFactory\Interceptor
    Magento\Catalog\Model\Product\Attribute\Backend\Price\Interceptor
    Magento\Catalog\Api\ProductRepositoryInterface\Interceptor
    Magento\Catalog\Model\Product\Interceptor
    Magento\Quote\Model\Quote\Item\ToOrderItem\Interceptor
    Magento\Catalog\Controller\Adminhtml\Product\Initialization\Helper\Interceptor
    Magento\Catalog\Model\Product\CartConfiguration\Interceptor
    Magento\Catalog\Model\Product\TypeTransitionManager\Interceptor
    Magento\Catalog\Model\Product\Type\Interceptor
    ... more messages ...
    On *nix systems, verify the Magento application has permissions to modify files created by the compiler in the "var" directory. 
    For instance, if you run the Magento application using Apache, the owner of the files in the "var" directory should be the Apache user 
    (example command: "chown -R www-data:www-data <MAGENTO_ROOT>/var" where MAGENTO_ROOT is the Magento root directory).

Related topics