{"id":17797377,"url":"https://github.com/steevanb/composer-overload-class","last_synced_at":"2025-06-28T07:36:16.066Z","repository":{"id":45888563,"uuid":"63103307","full_name":"steevanb/composer-overload-class","owner":"steevanb","description":"Allow to overload autoloaded classes, to include your files instead of supposed ones.","archived":false,"fork":false,"pushed_at":"2021-11-29T16:43:25.000Z","size":47,"stargazers_count":25,"open_issues_count":0,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-20T13:22:10.696Z","etag":null,"topics":["composer","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/steevanb.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-11T21:24:32.000Z","updated_at":"2025-04-14T00:16:41.000Z","dependencies_parsed_at":"2022-09-05T06:51:15.357Z","dependency_job_id":null,"html_url":"https://github.com/steevanb/composer-overload-class","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/steevanb/composer-overload-class","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steevanb%2Fcomposer-overload-class","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steevanb%2Fcomposer-overload-class/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steevanb%2Fcomposer-overload-class/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steevanb%2Fcomposer-overload-class/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/steevanb","download_url":"https://codeload.github.com/steevanb/composer-overload-class/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steevanb%2Fcomposer-overload-class/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261589981,"owners_count":23181446,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["composer","php"],"created_at":"2024-10-27T11:55:34.564Z","updated_at":"2025-06-28T07:36:16.045Z","avatar_url":"https://github.com/steevanb.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![version](https://img.shields.io/badge/version-1.4.0-green.svg)](https://github.com/steevanb/composer-overload-class/tree/1.4.0)\n[![composer](https://img.shields.io/badge/composer-^1.0||^2.0-blue.svg)](https://getcomposer.org)\n![Lines](https://img.shields.io/badge/code%20lines-508-green.svg)\n![Total Downloads](https://poser.pugx.org/steevanb/composer-overload-class/downloads)\n\ncomposer-overload-class\n-----------------------\n\nAllow to overload autoloaded classes, to include your files instead of supposed ones.\n\nSometimes, you need to overload a class from a dependency. But you can't, cause you've found a nice \"new Foo\\Bar()\" somewhere in this dependency...\n\nSo, if your project use Composer autoload (like Symfony projects for example), you can use steevanb/composer-overload-class.\n\nWith a simple configuration, you can specify to Composer in which file it will find a class (your file), instead of let him find original file with class namespace.\nCause you can't change namespace and class name of original class, otherwise all dependencies to this namespace / class name will fail\n(use Foo\\Bar, method parameter type, etc), composer-overload-class will clone Foo\\Bar class content into ComposerOverloadClass\\Foo namespace.\n\nYour class need to have exact same namespace as overloaded one, and you can extends ComposerOverloadClass\\Foo\\Bar if you need.\n\n![schema](schema.png)\n\n[Changelog](changelog.md)\n\nInstallation\n------------\n\n```bash\ncomposer require steevanb/composer-overload-class ^1.4\n```\n\nConfiguration\n-------------\n\nTo overload a class, you need to configure it via your composer.json.\n\nExample taken from [steevanb/doctrine-stats](https://github.com/steevanb/doctrine-stats), to overload Doctrine ObjectHydrator :\n```json\n# composer.json\n{\n    \"scripts\": {\n        \"__comment\": \"Add a script who generate cloned classes, when autoload is generated\",\n        \"pre-autoload-dump\": \"steevanb\\\\ComposerOverloadClass\\\\OverloadClass::overload\"\n    },\n    \"extra\": {\n        \"__comment\": \"Path to a writable directory, where overloaded classes will be cloned, with it's namespace prefixed by ComposerOverloadClass, in prod + dev env\",\n        \"composer-overload-cache-dir\": \"var/cache/prod\",\n        \"__comment\": \"Path to a writable directory, in dev env\",\n        \"composer-overload-cache-dir-dev\": \"var/cache/dev\",\n        \"__comment\": \"Classes to overload, in prod + dev env\",\n        \"composer-overload-class\": {\n            \"__comment\": \"Fully qualified class name you want to overload\",\n            \"Doctrine\\\\ORM\\\\Internal\\\\Hydration\\\\ObjectHydrator\": {\n                \"__comment\": \"Path to original file, who contains the class you want to overload\",\n                \"original-file\": \"vendor/doctrine/orm/lib/Doctrine/ORM/Internal/Hydration/ObjectHydrator.php\",\n                \"__comment\": \"Path to your file, who contains your class\",\n                \"overload-file\": \"vendor/steevanb/doctrine-stats/ComposerOverloadClass/Doctrine/ORM/Internal/ObjectHydrator.php\",\n                \"__comment\": \"false (default) : duplicate original class, add ComposerOverloadClass namespace prefix, you can extend it\",\n                \"__comment\": \"true : do not duplicate original class, you need to write all code in your classe\",\n                \"duplicate-original-file\": false\n            }\n        },\n        \"__comment\": \"Classes to overload, in dev env\",\n        \"composer-overload-class-dev\": {}\n    },\n    \"autoload\": {\n        \"psr-4\": {\n            \"ComposerOverloadClass\\\\\": \"var/cache/prod/ComposerOverloadClass\"\n        }\n    },\n    \"autoload-dev\": {\n        \"psr-4\": {\n            \"ComposerOverloadClass\\\\\": \"var/cache/dev/ComposerOverloadClass\"\n        }\n    },\n}\n```\n\nWhen configuration is finished, you need to re-generate Composer autoload :\n```bash\ncomposer dumpautoload\n\n# show overrided files\ncomposer dumpautoload -v\n```\n\nThat's all folks !\n\nExample with Doctrine ObjectHydrator\n------------------------------------\n\nExample taken from steevanb/doctrine-stats, to overload Doctrine ObjectHydrator, to add a timer when entities are hydrated :\n\n```php\n# src/ComposerOverloadClass/Doctrine/ORM/Internal/ObjectHydrator.php\n\nnamespace Doctrine\\ORM\\Internal\\Hydration;\n\nuse Doctrine\\ORM\\EntityManagerInterface;\nuse steevanb\\DoctrineStats\\Doctrine\\ORM\\Event\\HydrationEventsTrait;\n\n# extends cloned ObjectHydrator class, I just want to change hydrateAllData() code\nclass ObjectHydrator extends \\ComposerOverloadClass\\Doctrine\\ORM\\Internal\\Hydration\\ObjectHydrator\n{\n    use HydrationEventsTrait;\n\n    protected function getEntityManager(): EntityManagerInterface\n    {\n        return $this-\u003e_em;\n    }\n\n    protected function hydrateAllData(): void\n    {\n        $eventId = $this-\u003edispatchPreHydrationEvent();\n        parent::hydrateAllData();\n        $this-\u003edispatchPostHydrationEvent($eventId);\n    }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteevanb%2Fcomposer-overload-class","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsteevanb%2Fcomposer-overload-class","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteevanb%2Fcomposer-overload-class/lists"}