[2.2-dev] Move functions.php into Framework #16800

fooman · 2018-07-14T08:01:30Z

See discussion and comments in #16705 - this is a pull request for 2.2

Contribution checklist

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
All automated tests passed successfully (all builds on Travis CI are green)

magento-engcom-team · 2018-07-14T08:01:34Z

Hi @fooman. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento-engcom-team give me test instance - deploy test instance based on PR changes
@magento-engcom-team give me {$VERSION} instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Assistant documentation

fooman · 2018-07-18T03:01:20Z

Updated the PR to fix the noted short name violation of __.php (squashed into 1 commit)

ihor-sviziev · 2018-07-18T04:56:39Z

lib/internal/Magento/Framework/Phrase/__function.php

+ *
+ * @return \Magento\Framework\Phrase
+ */
+function __()


Wasn't idea to put this function in Magento/Framework/Phrase/ - \Magento\Framework\Phrase namespace?

I don't think that was proposed so far. Wouldn't namespacing the function mean all existing templates would need to be adjusted?

Let's wait @orlangur for review

fooman · 2018-07-23T21:43:08Z

@orlangur any thing else to do here before it can be merged?

fooman · 2018-08-06T11:42:37Z

@orlangur or @ihor-sviziev anything else needed here?

orlangur · 2018-08-06T13:09:46Z

@fooman sorry for delay, started review almost immediately but didn't finish it. Will do now.

orlangur · 2018-08-13T12:27:40Z

lib/internal/Magento/Framework/Phrase/__function.php

@@ -0,0 +1,22 @@
+<?php


Which rule was violated by __.php name?

It was actually the function name itself __() which triggered the violation. As this was previously not occurring I assumed it was related to the file name. It turned out that wasn't the case and that __() was always in violation but making the changes brought this up.

If you have a strong preference I can change the filename __function.php back to __.php.

Please do so.

orlangur · 2018-08-13T12:28:31Z

lib/internal/Magento/Framework/Phrase/registration.php

@@ -0,0 +1,4 @@
+<?php
+if (!function_exists('__')) {
+    require '__function.php';


What is the use for such registration file?

The main idea of splitting this out is the following:

The standard way of installing Magento 2 should be through Composer. In this case you will get the __function.php included directly through the Composer autoloader - no further requires needed. Also this registration file would not be loaded.

Only if you clone from Github app/etc/NonComposerComponentRegistration.php will kick in and find this registration file which in turn will require __function.php.

@orlangur we could mark this file deprecated as well as it should get removed at the same time as app/functions.php

Such file is a bit confusing, please just include __.php in registration.php of Magento Framework.

orlangur · 2018-08-13T12:29:26Z

lib/internal/Magento/Framework/composer.json

@@ -45,7 +45,8 @@
            "Magento\\Framework\\": ""
        },
        "files": [
-            "registration.php"
+            "registration.php",
+            "Phrase/__function.php"


I meant to just require __.php in registration of framework.

To me the final goal should be to use Composer to supply autoloaded files. Using registration.php is an intermediate step which we could do without. It also keeps the purpose of the registration file.

Using registration.php is an intermediate

There is no need to do something differently until we get rid of them.

So, instead of including __.php separately just do it within registration.php.

orlangur · 2018-08-13T12:31:52Z

app/functions.php

-    if (!empty($argc) && is_array($argc[0])) {
-        $argc = $argc[0];
+$vendorDir = require VENDOR_PATH;
+if (!function_exists('__')) {


Why not simply move such logic into __.php? It's better to mark app/functions.php as deprecated without any changes.

fooman · 2018-08-16T07:56:19Z

@orlangur okay changed this to how you suggested so that we can get this merged

orlangur

@fooman great! Even simpler than I thought it will be 👍

magento-engcom-team · 2018-09-03T16:46:38Z

Hi @orlangur, thank you for the review.
ENGCOM-2915 has been created to process this Pull Request

magento-engcom-team · 2018-09-06T17:32:06Z

Hi @fooman. Thank you for your contribution.
We will aim to release these changes as part of 2.2.7.
Please check the release notes for final confirmation.

Please, consider to port this solution to 2.3 release line.
You may use Porting tool to port commits automatically.

magento-engcom-team added the Component: Framework/Phrase label Jul 14, 2018

fooman mentioned this pull request Jul 14, 2018

Move functions.php into Framework #16705

Closed

4 tasks

orlangur self-assigned this Jul 15, 2018

fooman force-pushed the move-functions-2.2 branch from 338a7c0 to 4fcb412 Compare July 18, 2018 03:00

fooman force-pushed the move-functions-2.2 branch from 4fcb412 to e8f5186 Compare July 18, 2018 03:02

ihor-sviziev reviewed Jul 18, 2018

View reviewed changes

orlangur requested changes Aug 13, 2018

View reviewed changes

orlangur added the Progress: needs update label Aug 13, 2018

Move functions.php into Framework

c8860f5

fooman force-pushed the move-functions-2.2 branch from 03a3aa7 to c8860f5 Compare August 14, 2018 20:39

ihor-sviziev requested a review from orlangur August 16, 2018 08:06

orlangur approved these changes Sep 3, 2018

View reviewed changes

magento-engcom-team added this to the Release: 2.2.7 milestone Sep 3, 2018

magento-engcom-team added the Release Line: 2.2 label Sep 3, 2018

magento-engcom-team added Progress: accept and removed Progress: needs update labels Sep 3, 2018

magento-engcom-team merged commit c8860f5 into magento:2.2-develop Sep 6, 2018

magento-engcom-team pushed a commit that referenced this pull request Sep 6, 2018

ENGCOM-2915: [2.2-dev] Move functions.php into Framework #16800

c0018c5

fooman mentioned this pull request Sep 7, 2018

[Forwardport] Move functions.php into Framework #17960

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2.2-dev] Move functions.php into Framework #16800

[2.2-dev] Move functions.php into Framework #16800

fooman commented Jul 14, 2018

magento-engcom-team commented Jul 14, 2018

fooman commented Jul 18, 2018

ihor-sviziev Jul 18, 2018

fooman Jul 18, 2018

ihor-sviziev Jul 20, 2018

fooman commented Jul 23, 2018

fooman commented Aug 6, 2018

orlangur commented Aug 6, 2018

orlangur Aug 13, 2018

fooman Aug 13, 2018

orlangur Aug 14, 2018

orlangur Aug 13, 2018

fooman Aug 13, 2018

fooman Aug 13, 2018

orlangur Aug 14, 2018

orlangur Aug 13, 2018

fooman Aug 13, 2018 •

edited

Loading

orlangur Aug 14, 2018

orlangur Aug 13, 2018

fooman commented Aug 16, 2018

orlangur left a comment

magento-engcom-team commented Sep 3, 2018

magento-engcom-team commented Sep 6, 2018

[2.2-dev] Move functions.php into Framework #16800

[2.2-dev] Move functions.php into Framework #16800

Conversation

fooman commented Jul 14, 2018

Contribution checklist

magento-engcom-team commented Jul 14, 2018

fooman commented Jul 18, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fooman commented Jul 23, 2018

fooman commented Aug 6, 2018

orlangur commented Aug 6, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fooman Aug 13, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fooman commented Aug 16, 2018

orlangur left a comment

Choose a reason for hiding this comment

magento-engcom-team commented Sep 3, 2018

magento-engcom-team commented Sep 6, 2018

fooman Aug 13, 2018 •

edited

Loading