Ability to override Zend library #3462

henrykbrzoska · 2023-08-21T15:38:56Z

henrykbrzoska
Aug 21, 2023

Description (*)

I would like to request an enhancement to be able override classes from shardj/zf1-future library.

Expected behavior (*)

Not getting
Fatal error: Cannot declare class Zend_XXX_YYY_ZZZ, because the name is already in use in /var/www/html/htdocs/vendor/shardj/zf1-future/library/Zend/XXX/YYY/ZZZ.php

Benefits

Save the world.

Additional information

as an example:
create app/code/local/Zend/Locale/Format.php
Comment out all require_once in file(because this classes are loaded). So was in lib/Zend before taking it from composer
change some item qty in cart
this will use Zend_Filter_LocalizedToNormalized
vendor/shardj/zf1-future/library/Zend/Filter/LocalizedToNormalized.php:30 throws
Fatal error: Cannot declare class Zend_Locale_Format, because the name is already in use in /var/www/html/htdocs/vendor/shardj/zf1-future/library/Zend/Locale/Format.php

fballiano · 2023-08-21T16:33:23Z

fballiano
Aug 21, 2023

It would be nice, I don't know at the moment ho we could achieve it tho, any ideas?

3 replies

Sdfendor May 13, 2024

In our shop we override one smaller aspect of it via composer patch. But it's quite a bit of manual work and for larger rewrites it doesn't feels smooth.

pquerner May 13, 2024

Can you share a sample composer patch, perhaps?
(No code changes, just change a word or something, just so that I see how exactly it works)

Sdfendor May 13, 2024

While I could share my specific example, I rather first share the package I used to help me with creating this patch: https://github.com/symplify/vendor-patches. With the documentation given, I think the process is not complex. You only need the composer package for patch creation not to apply/run the patches. The created patches are applied via https://github.com/cweagans/composer-patches (which is also a dependency in the OpenMage composer.json and used to apply some specific changes to shardj/zf1-future).

pquerner · 2023-08-21T16:38:04Z

pquerner
Aug 21, 2023

Like I proposed in Discord, maybe the composer feature to autoload a file can be used. Not sure if that invalidates PSR0 but I dont see how. You simply come first, and the autoloader finds your file first, before zf1future comes along.

{
    "name": "your/magento-base",
    "autoload": {
      "files": ["your/lib/Zend/Locale/Format.php"]
    }
}

where this package requires openmage/magento-lts (composer.json is unfinished obviously)

(How we would do that in non-composer setups however.. I dont know)

3 replies

fballiano Aug 21, 2023

well, I think this is the cleanest way and it can be used already today :-)

henrykbrzoska Aug 21, 2023
Author

but it is not working

pquerner Aug 21, 2023

True, can confirm.

composer.json

{
    "name": "your/magento-base",
    "require": {
        "openmage/magento-lts": "^19.5.0",
        "aydin-hassan/magento-core-composer-installer": "*"
    },
    "config": {
        "allow-plugins": {
            "cweagans/composer-patches": true,
            "magento-hackathon/magento-composer-installer": true,
            "aydin-hassan/magento-core-composer-installer": true
        }
    },
    "php": "8.1",
    "autoload": {
      "files": ["./my_folder/Zend/Locale/Format.php"]
    },
    "extra": {
        "magento-core-package-type": "magento-source",
        "magento-root-dir": "htdocs"
    }
}

Format.php

<?php

class Zend_Locale_Format
{
    public function _construct() {
        die("hello world");
    }
}

Init with ddev, set php version to 8.1, load the page. Should crash immediately.

(did a composer dump -o)

composer autoload files show the file in the _files.php file and also in the _static.php file - therefore should be loaded correctly - but doesnt somehow.

Error with xdebug enabled:

<br class="Apple-interchange-newline">

( ! ) Fatal error: Cannot declare class Zend_Locale_Format, because the name is already in use in /var/www/html/vendor/shardj/zf1-future/library/Zend/Locale/Format.php on line 35
--


1 | 0.0089 | 385128 | {main}( ) | .../index.php:0
2 | 0.0148 | 462040 | Mage::run( $code = '', $type = 'store', $options = ??? ) | .../index.php:55
3 | 0.0185 | 600328 | Mage_Core_Model_App->run( $params = ['scope_code' => '', 'scope_type' => 'store', 'options' => []] ) | .../Mage.php:742
4 | 0.1403 | 1437504 | Mage_Core_Model_Resource_Setup::applyAllDataUpdates( ) | .../App.php:362
5 | 0.1405 | 1439264 | Mage_Core_Model_Resource_Setup->applyDataUpdates( ) | .../Setup.php:259
6 | 0.1405 | 1439488 | Mage_Core_Model_Resource_Setup->_installData( $newVersion = '1.6.0.0.19.1.6' ) | .../Setup.php:278
7 | 0.1405 | 1439488 | Mage_Core_Model_Resource_Setup->_modifyResourceDb( $actionType = 'data-install', $fromVersion = '', $toVersion = '1.6.0.0.19.1.6' ) | .../Setup.php:379
8 | 0.1409 | 1442352 | include( '/var/www/html/htdocs/app/code/core/Mage/Catalog/data/catalog_setup/data-install-1.6.0.0.php ) | .../Setup.php:610
9 | 0.1421 | 1516312 | Mage_Core_Model_Abstract->load( $id = 1, $field = ??? ) | .../data-install-1.6.0.0.php:21
10 | 0.1463 | 1589464 | Mage_Catalog_Model_Resource_Abstract->load( $object = class Mage_Catalog_Model_Category { protected $_data = []; protected $_hasDataChanges = FALSE; protected $_origData = []; protected $_idFieldName = 'entity_id'; protected $_isDeleted = FALSE; protected $_oldFieldsMap = []; protected $_syncFieldsMap = []; protected $_dirty = NULL; protected $_eventPrefix = 'catalog_category'; protected $_eventObject = 'category'; protected $_resourceName = 'catalog/category'; protected $_resource = NULL; protected $_resourceCollectionName = 'catalog/category_collection'; protected $_cacheTag = 'catalog_category'; protected $_dataSaveAllowed = TRUE; protected $_isObjectNew = TRUE; protected $_defaultValues = []; protected $_storeValuesFlags = []; protected $_lockedAttributes = []; protected $_isDeleteable = TRUE; protected $_isReadonly = FALSE; protected $_useFlatResource = FALSE; private $_designAttributes = [0 => 'custom_design', 1 => 'custom_design_from', 2 => 'custom_design_to', 3 => 'page_layout', 4 => 'custom_layout_update', 5 => 'custom_apply_to_products']; protected $_treeModel = NULL; protected $_urlModel = NULL }, $entityId = 1, $attributes = NULL ) | .../Abstract.php:234
11 | 0.1463 | 1589464 | Mage_Eav_Model_Entity_Abstract->load( $object = class Mage_Catalog_Model_Category { protected $_data = []; protected $_hasDataChanges = FALSE; protected $_origData = []; protected $_idFieldName = 'entity_id'; protected $_isDeleted = FALSE; protected $_oldFieldsMap = []; protected $_syncFieldsMap = []; protected $_dirty = NULL; protected $_eventPrefix = 'catalog_category'; protected $_eventObject = 'category'; protected $_resourceName = 'catalog/category'; protected $_resource = NULL; protected $_resourceCollectionName = 'catalog/category_collection'; protected $_cacheTag = 'catalog_category'; protected $_dataSaveAllowed = TRUE; protected $_isObjectNew = TRUE; protected $_defaultValues = []; protected $_storeValuesFlags = []; protected $_lockedAttributes = []; protected $_isDeleteable = TRUE; protected $_isReadonly = FALSE; protected $_useFlatResource = FALSE; private $_designAttributes = [0 => 'custom_design', 1 => 'custom_design_from', 2 => 'custom_design_to', 3 => 'page_layout', 4 => 'custom_layout_update', 5 => 'custom_apply_to_products']; protected $_treeModel = NULL; protected $_urlModel = NULL }, $entityId = 1, $attributes = NULL ) | .../Abstract.php:737
12 | 0.1497 | 1860320 | Mage_Eav_Model_Entity_Abstract->_afterLoad( $object = class Mage_Catalog_Model_Category { protected $_data = []; protected $_hasDataChanges = FALSE; protected $_origData = []; protected $_idFieldName = 'entity_id'; protected $_isDeleted = FALSE; protected $_oldFieldsMap = []; protected $_syncFieldsMap = []; protected $_dirty = NULL; protected $_eventPrefix = 'catalog_category'; protected $_eventObject = 'category'; protected $_resourceName = 'catalog/category'; protected $_resource = NULL; protected $_resourceCollectionName = 'catalog/category_collection'; protected $_cacheTag = 'catalog_category'; protected $_dataSaveAllowed = TRUE; protected $_isObjectNew = TRUE; protected $_defaultValues = []; protected $_storeValuesFlags = []; protected $_lockedAttributes = []; protected $_isDeleteable = TRUE; protected $_isReadonly = FALSE; protected $_useFlatResource = FALSE; private $_designAttributes = [0 => 'custom_design', 1 => 'custom_design_from', 2 => 'custom_design_to', 3 => 'page_layout', 4 => 'custom_layout_update', 5 => 'custom_apply_to_products']; protected $_treeModel = NULL; protected $_urlModel = NULL } ) | .../Abstract.php:944
13 | 0.1497 | 1860696 | Mage_Eav_Model_Entity_Abstract->walkAttributes( $partMethod = 'backend/afterLoad', $args = [0 => class Mage_Catalog_Model_Category { protected $_data = [...]; protected $_hasDataChanges = FALSE; protected $_origData = [...]; protected $_idFieldName = 'entity_id'; protected $_isDeleted = FALSE; protected $_oldFieldsMap = [...]; protected $_syncFieldsMap = [...]; protected $_dirty = NULL; protected $_eventPrefix = 'catalog_category'; protected $_eventObject = 'category'; protected $_resourceName = 'catalog/category'; protected $_resource = NULL; protected $_resourceCollectionName = 'catalog/category_collection'; protected $_cacheTag = 'catalog_category'; protected $_dataSaveAllowed = TRUE; protected $_isObjectNew = TRUE; protected $_defaultValues = [...]; protected $_storeValuesFlags = [...]; protected $_lockedAttributes = [...]; protected $_isDeleteable = TRUE; protected $_isReadonly = FALSE; protected $_useFlatResource = FALSE; private $_designAttributes = [...]; protected $_treeModel = NULL; protected $_urlModel = NULL }] ) | .../Abstract.php:1617
14 | 0.1502 | 1862768 | Mage_Eav_Model_Entity_Attribute_Backend_Time_Created->afterLoad( $object = class Mage_Catalog_Model_Category { protected $_data = []; protected $_hasDataChanges = FALSE; protected $_origData = []; protected $_idFieldName = 'entity_id'; protected $_isDeleted = FALSE; protected $_oldFieldsMap = []; protected $_syncFieldsMap = []; protected $_dirty = NULL; protected $_eventPrefix = 'catalog_category'; protected $_eventObject = 'category'; protected $_resourceName = 'catalog/category'; protected $_resource = NULL; protected $_resourceCollectionName = 'catalog/category_collection'; protected $_cacheTag = 'catalog_category'; protected $_dataSaveAllowed = TRUE; protected $_isObjectNew = TRUE; protected $_defaultValues = []; protected $_storeValuesFlags = []; protected $_lockedAttributes = []; protected $_isDeleteable = TRUE; protected $_isReadonly = FALSE; protected $_useFlatResource = FALSE; private $_designAttributes = [0 => 'custom_design', 1 => 'custom_design_from', 2 => 'custom_design_to', 3 => 'page_layout', 4 => 'custom_layout_update', 5 => 'custom_apply_to_products']; protected $_treeModel = NULL; protected $_urlModel = NULL } ) | .../Abstract.php:641
15 | 0.1502 | 1863040 | Mage_Core_Model_Locale->storeDate( $store = NULL, $date = NULL, $includeTime = TRUE, $format = NULL ) | .../Created.php:74
16 | 0.1502 | 1863088 | Composer\Autoload\ClassLoader->loadClass( $class = 'Zend_Date' ) | .../Locale.php:548
17 | 0.1502 | 1863200 | Composer\Autoload\{closure:/var/www/html/vendor/composer/ClassLoader.php:575-577}( $file = '/var/www/html/vendor/composer/../shardj/zf1-future/library/Zend/Date.php' ) | .../ClassLoader.php:427
18 | 0.1535 | 1929096 | include( '/var/www/html/vendor/shardj/zf1-future/library/Zend/Date.php ) | .../ClassLoader.php:576
19 | 0.1565 | 1929648 | require_once( '/var/www/html/vendor/shardj/zf1-future/library/Zend/Locale/Format.php ) | .../Date.php:27

pquerner · 2023-08-21T16:45:39Z

pquerner
Aug 21, 2023

Otherwise we put this in the Mage.php to allow special overwrites for Zend, which can be extended in the future?
(Or better yet, since Mage is final, somewhere else which is better to oberwrite - or outsource to XML Struct)

spl_autoload_register(function ($class) {
    // if Zend and exists in app/local, then include from there, else ask the composer autoloader (exit here)
}, true, true);

1 reply

pquerner Oct 11, 2023

magento-lts/app/Mage.php

Lines 57 to 59 in b1a879c

    
           foreach (glob(BP . DS . 'app' . DS . 'etc' . DS . 'includes' . DS . '*.php') as $path) { 
        
               include_once $path; 
        
           }

Can we load our overwritten Zend classes here? And when the original require_once comes along our class is simply already loaded?

(If its an easy Zend class, with not too many require_once itself)

henrykbrzoska · 2023-08-21T17:06:25Z

henrykbrzoska
Aug 21, 2023
Author

Otherwise we put this in the Mage.php to allow special overwrites for Zend, which can be extended in the future? (Or better yet, since Mage is final, somewhere else which is better to oberwrite - or outsource to XML Struct)
spl_autoload_register(function ($class) {
    // if Zend and exists in app/local, then include from there, else ask the composer autoloader (exit here)
}, true, true); 

it will not work because other parts of zend loads overriden class second time

this shardj/zf1-future is not compatible with old lib/Zend because library was loaded with require_once commented out
old one:

the only one way to change something in Zend/Locale/Format.php is to override every class which have require_once 'Zend/Locale/Format.php';
than override every class which have class which require Zend/Locale/Format.php
repeat with every class which have class which have class which require Zend/Locale/Format.php

5 replies

pquerner Aug 21, 2023

So you are saying you tell the autoloader that it can find the class Zend_Locale_Format at /some/where/Zend/Locale/Format.php and then when the class Zend_Filter_LocalizedToNormalized comes along, it will retrigger the autoloader and ignores your /some/where/Zend/Locale/Format.php but instead goes into vendor/zf1future/.../Format.php ?
Why?

henrykbrzoska Aug 21, 2023
Author

but vendor/zf1future/.../Format.php is not loaded by autoloader. It is loaded by vendor/shardj/zf1-future/library/Zend/Filter/LocalizedToNormalized.php line 30
there we have
require_once 'Zend/Locale/Format.php';

The main issue is that previously(in lib/Zend) this line was commented out(see second screenshot), and here(zf1future) is not commented out.

henrykbrzoska Aug 21, 2023
Author

maby we need a fork of zf1future where we make something like this
if(!class_exists(Zend_Locale_Format)){ require_once 'Zend/Locale/Format.php'; }
with every require_once

pquerner Aug 21, 2023

We should ask the devs of zf1future if its really needed to have these require_once statements in there in the age of composer ...
Probably to not poke the bear and leave it as is.

henrykbrzoska Aug 21, 2023
Author

from what i remember that was the one of main reasons that pushed us/them/IBM/'php world' to use psr-4 and namespaces

pquerner · 2023-10-11T07:51:51Z

pquerner
Oct 11, 2023

@henrykbrzoska Did you continue to work on a solution for this?
Best last guess would be to use a fork of zf1future and make your changes there. Meaning you have to keep up with the changes yourself, instead of OM releases.

0 replies

elidrissidev · 2023-10-11T08:41:53Z

elidrissidev
Oct 11, 2023
Maintainer

The best thing would be for zf1-future to make use of the composer autoloader and remove all the require_once statements from the code, but alas Shardj/zf1-future#348...

17 replies

Flyingmana May 9, 2024

while zf1future only promises 8.1 compat

and they declined to provide higher compat in the future?

Users of openmage can easily use composer to configure an alternative already

How? Do you have an example composer.json file at hand?

not sure, its a few years since I last did something in this direction.
maybe its https://getcomposer.org/doc/articles/aliases.md#require-inline-alias

What other benefits are there for us as maintainers and for us as project?

That is difficult to answer, because I dont know how these 2 repos differ. Just that the other one does not rely on require_onces in the codebase and the current in use is strict about "this is for legacy projects, where require_once had to be used for the lack of a proper autoloader".

For us this is important, because we could easily switch, but then someone else comes with another reason why zf1f has something they think is more important, so we will switch back again.
Having the full comparison enables us to do a longterm decision which protects us from a situation where we need to change course only a year later.

pquerner May 9, 2024

and they declined to provide higher compat in the future?

its how it is as of today. i've not read their issues or pr chats to find an answer to that question.

elidrissidev · 2024-05-13T18:20:23Z

elidrissidev
May 13, 2024
Maintainer

I think I found a working solution, please check #3989.

1 reply

sreichel Aug 22, 2024
Collaborator

It works for zf1s, but not for zf1-future ... :(

luigifab · 2024-05-15T20:17:46Z

sreichel Aug 22, 2024
Collaborator

@luigifab it does, but comment require_once does not solve the problem :(

Ability to override Zend library #3462

Description (*)

Expected behavior (*)

Benefits

Additional information

Replies: 8 comments · 34 replies

henrykbrzoska Aug 21, 2023 Author

henrykbrzoska Aug 21, 2023 Author

henrykbrzoska Aug 21, 2023 Author

henrykbrzoska Aug 21, 2023 Author

henrykbrzoska Aug 21, 2023 Author

elidrissidev Oct 11, 2023 Maintainer

elidrissidev May 13, 2024 Maintainer

sreichel Aug 22, 2024 Collaborator

sreichel Aug 22, 2024 Collaborator

Replies: 8 comments 34 replies

henrykbrzoska Aug 21, 2023
Author

henrykbrzoska
Aug 21, 2023
Author

henrykbrzoska Aug 21, 2023
Author

henrykbrzoska Aug 21, 2023
Author

henrykbrzoska Aug 21, 2023
Author

elidrissidev
Oct 11, 2023
Maintainer

elidrissidev
May 13, 2024
Maintainer

sreichel Aug 22, 2024
Collaborator

sreichel Aug 22, 2024
Collaborator