[#3447] - [#33612] Add a extension installer script feature
- Fixed in Code Base
- 7 May 2016
- Medium
- Build: staging
- # 3447
- Diff
- wilsonge:extensionscript
- Foreign ID 33612
- Success continuous-integration/travis-ci/pr The Travis CI build passed Details
User tests: Successful: Unsuccessful:
Feature Basics
This is a helper for developers using install scripts in their extensions it allows you to:
- Get and set parameters (method getParams and setParam available for this - you can also get all instances of a module with getInstances to help)
- Stop users from downgrading versions (set allowDowngrades class var to true)
- Move CLI scripts into the CLI folder (by putting the path to the cli scripts in the class var array)
- Check for a minimum PHP and Joomla version (by setting the strings for the minimum versions in the relevant class var)
- Remove out of date files and folders (by putting the path to the files in the class var array)
Usage
Simply by extending the helper class and setting the extension name in the form of com_foobar, mod_foobar etc. in the $this->extension class var
Testing
Try using the feature in extensions - as this is a utility class for developers there's no easy visible effects for user testing
| Labels |
Added:
?
?
|
||
| Title |
|
||||||
| Description | <p><a href="http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemEdit&tracker_item_id=33612&start=0">http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemEdit&tracker_item_id=33612&start=0</a></p> <h2>Feature Basics</h2> <p>This is a helper for developers using install scripts in their extensions it allows you to:</p> <ul> <li>Get and set parameters (method getParams and setParam available for this - you can also get all instances of a module with getInstances to help)</li> <li>Stop users from downgrading versions (set allowDowngrades class var to true)</li> <li>Move CLI scripts into the CLI folder (by putting the path to the cli scripts in the class var array)</li> <li>Check for a minimum PHP and Joomla version (by setting the strings for the minimum versions in the relevant class var)</li> <li>Remove out of date files and folders (by putting the path to the files in the class var array)</li> </ul><h2>Usage</h2> <p>Simply by extending the helper class and setting the extension name in the form of com_foobar, mod_foobar etc. in the <code>$this->extension</code> class var</p> <h2>Testing</h2> <p>Try using the feature in extensions - as this is a utility class for developers there's no easy visible effects for user testing</p> | ⇒ | <p><a href="http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemEdit&tracker_item_id=33612&start=0">http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemEdit&tracker_item_id=33612&start=0</a></p> <h2>Feature Basics</h2> <p>This is a helper for developers using install scripts in their extensions it allows you to:</p> <ul class="task-list"> <li>Get and set parameters (method getParams and setParam available for this - you can also get all instances of a module with getInstances to help)</li> <li>Stop users from downgrading versions (set allowDowngrades class var to true)</li> <li>Move CLI scripts into the CLI folder (by putting the path to the cli scripts in the class var array)</li> <li>Check for a minimum PHP and Joomla version (by setting the strings for the minimum versions in the relevant class var)</li> <li>Remove out of date files and folders (by putting the path to the files in the class var array)</li> </ul><h2>Usage</h2> <p>Simply by extending the helper class and setting the extension name in the form of com_foobar, mod_foobar etc. in the <code>$this->extension</code> class var</p> <h2>Testing</h2> <p>Try using the feature in extensions - as this is a utility class for developers there's no easy visible effects for user testing</p> |
| Labels |
Added:
?
|
||
nicksavov
- | Labels |
Removed:
?
|
||
| Status | New | ⇒ | Pending |
Don't you think that we should find a different name for this class?
the supposed way we should use this is by extending, but extending from a helper class doesn't seem right to me. A helper class should not be extended from - it is normally something that we have just because we have no clue where to put the functionality.
I would actually prefer if you move this to the installer folder and call the class something like installerscriptbase???
Other than that - great! A lot of us have written their own installers. You are covering a lot of things. What would make it even better is if you had plugin, module & library installers there :)
Something like here: https://github.com/compojoom/lib_compojoom/blob/master/source/libraries/compojoom/installer/installer.php#L110
I'm easy as to the name of the class and it's location. Yes you're right it might well be better in libraries/cms/installer.
I considered the library, module and plugin installers but in my opinion core should be persuading people to use packages - they're getting much better in terms of core support since the standardisation we did in 3.4. What do you think?
@wilsonge see wilsonge#13
The helper class is renamed to JInstallerScript and I've updated 3.4 references to 3.5.
What would make it even better is if you had plugin, module & library installers there
I tend to agree with @wilsonge on using packages instead of extending a specific adapter to add more extensions. Admittedly there are some weaknesses in the package adapter that need to be worked on to make it more enticing for developers (i.e. one failed extension install aborts the whole thing leaving a partial package install), but I think our focus for core should be moving in that direction.
| Labels |
Added:
?
|
||
roland-d
- | Milestone |
Added: |
||
| Labels | |||
| Category | ⇒ | Installation |
| Labels | |||
| Category | Installation | ⇒ | Installation Language & Strings |
| Labels | |||
This PR has received new commits.
CC: @compojoom
This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/3447.
This PR has received new commits.
CC: @compojoom
This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/3447.
| Status | Pending | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2016-05-07 14:25:06 |
| Closed_By | ⇒ | Kubik-Rubik |
Please alpha sort the new strings