Modified PHP linker to use configurable autoloaders and include paths #205
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This allows modules to specify autoloaders and include paths using a JSON config file in etc/linker.d.
tyearke
added
the
enhancement
smgallo
suggested changes
Aug 4, 2017
configuration/linker.php
Outdated
| // Load linker configuration. | ||
| require_once("$baseDir/classes/CCR/Json.php"); | ||
| require_once("$baseDir/classes/Xdmod/Config.php"); | ||
| $config = Xdmod\Config::factory(); |
There was a problem hiding this comment.
We need to add some comments in here because it's a pain looking at the Xdmod\Config class code to figure out that it's loading the file on demand. Something like "Autoload linker configuration from linker.json" should be sufficient.
configuration/linker.php
Outdated
| require_once("$baseDir/classes/CCR/Json.php"); | ||
| require_once("$baseDir/classes/Xdmod/Config.php"); | ||
| $config = Xdmod\Config::factory(); | ||
| $linkerConfig = $config['linker']; |
There was a problem hiding this comment.
If the file doesn't exist catch the exception and report a useful message.
configuration/linker.php
Outdated
| $include_path .= ":" . $baseDir . '/classes/ReportTemplates'; | ||
| $include_path .= ":" . $baseDir . '/classes/AppKernel'; | ||
| $include_path .= ":" . $baseDir . '/libraries/HighRoller_1.0.5'; | ||
| foreach ($linkerConfig['include_dirs'] as $includeDirPath) { |
There was a problem hiding this comment.
Should we throw a warning if include_dirs doesn't exist?
smgallo
approved these changes
Aug 4, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request allows modules to specify PHP autoloaders and include paths using JSON config files in
etc/linker.d.Motivation and Context
XDMoD requires additional PHP libraries beyond Open XDMoD's requirements. This pull request allows those libraries to be used without having to directly reference them in Open XDMoD.
Tests Performed
Deployed modified code and verified that the instance worked as expected. Modified deployments with debug code to verify that the final include path stayed identical to the path before this change.
Types of changes
Checklist:
I have added tests to cover my changes.