dev/core#472 Allow for APIv3 to find examples in Extenion folders as … #13006
Conversation
|
(Standard links)
|
|
I was able to get this to work by adding a folder/file to an extension called examples/ReportTemplate/Getmetadata.php This showed up in the examples. However, I note that you add the entity with checking if it is already present & without alphabetical sorting so I get
My other reservation are
SInce this is pretty edge functionality I could probably swallow those 3 if the duplicate entity were fixed |
eileenmcnaughton
added
the
sig:extension support
|
I think the code here could be greatly simplified by scanning all directories in the php include_path instead of all this extension loading rigamarole. I've done it that way in a couple other places and it's worked out well, since Civi adds every extension directory to the include path. This code for example looks in every spot in the include path for a |
seamuslee001
force-pushed
the
lab_core_472
branch
from
7aee7a8 to
03aa59c
Compare
|
@eileenmcnaughton I have now alpha sorted and switched to the include_path fucntion as suggested by @colemanw. By using the include_path then that solves 2. as only enabled extensions are on the included path. I don't think we can fully stop the duplicate entity thing because i don't believe there are API rules to stop that from happening. |
CRM/Admin/Page/APIExplorer.php
Outdated
| // Remove this so that we only get one version of each folder. | ||
| if (substr($path, -7) == 'civicrm' || substr($path, -17) == 'civicrm//packages') { | ||
| continue; | ||
| } |
There was a problem hiding this comment.
@seamuslee001 I think this might be different on different sites, and the best way to dedupe would be a little preprocessing to remove trailing slashes before running array_unique (note that on some systems the slash will be a backslash)
I think ideally the list would be deduped and all ReportTemplate examples would be shown for the combined list item. |
|
yep @seamuslee001 - the list double up issue can be fixed by array wrangling - e.g flip it & sort it & flip it back. |
seamuslee001
force-pushed
the
lab_core_472
branch
from
03aa59c to
9b30dfb
Compare
|
@colemanw @eileenmcnaughton i think the duplicate issue is fully dealt with now, I have also ensured my code is safeguarded for Windows and Non windows installs. I believe all concerns have now been addressed |
…well as core Improve inclusion scanning by using get_include_path as suggested by Coleamn and alpha sort the list of entities Deal with windows directory separators and more helpfully handle the trailing and non trailing slash directories Further fixes for windows Directory Separators
seamuslee001
force-pushed
the
lab_core_472
branch
from
9b30dfb to
7d16f66
Compare
|
Unrelated test fail. Code looks good, and confirmed existing examples still work on the demo site. |
…well as core
Overview
This allows for the APIv3 Explorer to pick up examples that might be found in an extension in api/v3/examples/ just like how its in core
Before
Only Core examples found
After
Extension examples found as well as core
ping @eileenmcnaughton @colemanw @totten