Skip to content
Snippets Groups Projects
Commit a8e6499c authored by hahn's avatar hahn
Browse files

update docs in build plugin files

parent 918336d9
No related branches found
No related tags found
1 merge request!195534 add docker
...@@ -6,14 +6,12 @@ ...@@ -6,14 +6,12 @@
*/ */
interface iBuildplugin { interface iBuildplugin {
// ----------------------------------------------------------------------
// VERIFY
// ----------------------------------------------------------------------
/** /**
* check requirements if the plugin could work * get an array of commands to check requirements
public function checkRequirements(); * if the plugin is able to work
* @return array
*/ */
public function checkRequirements();
/** /**
* get an array with shell commands to execute * get an array with shell commands to execute
...@@ -21,21 +19,5 @@ interface iBuildplugin { ...@@ -21,21 +19,5 @@ interface iBuildplugin {
*/ */
public function getBuildCommands(); public function getBuildCommands();
/**
* get name of plugin as string ... language specific
public function getName();
*/
/**
* get description of plugin as string ... language specific
public function getDescription();
*/
/**
* get array of data in info.js
public function getPluginInfos();
*/
} }
...@@ -111,15 +111,23 @@ class build_base implements iBuildplugin{ ...@@ -111,15 +111,23 @@ class build_base implements iBuildplugin{
return $this->_sOutfile=$sOutFilename ? $sOutFilename.$this->getExtension() : $this->_sOutfile; return $this->_sOutfile=$sOutFilename ? $sOutFilename.$this->getExtension() : $this->_sOutfile;
} }
// --------------------------------------------------------------- // ---------------------------------------------------------------
// GETTER // GETTER
// --------------------------------------------------------------- // ---------------------------------------------------------------
/**
* check requirements if the plugin could work
* @return array
*/
public function checkRequirements() {
return [
'echo "ERROR: The method checkRequirements() was not implemented in the build plugin ['.$this->getId().']"',
'exit 1'
];
}
/** /**
* get an array with shell commands to execute * get an array with shell commands to execute
* @param string $sBuildDir full path of the build directory
* @param string $sOutFilename filename for output
* @return array * @return array
*/ */
public function getBuildCommands(){ public function getBuildCommands(){
......
...@@ -10,6 +10,7 @@ class build_tgz extends build_base { ...@@ -10,6 +10,7 @@ class build_tgz extends build_base {
/** /**
* check requirements if the plugin could work * check requirements if the plugin could work
* @return array
*/ */
public function checkRequirements() { public function checkRequirements() {
return [ return [
...@@ -19,8 +20,6 @@ class build_tgz extends build_base { ...@@ -19,8 +20,6 @@ class build_tgz extends build_base {
/** /**
* get an array with shell commands to execute * get an array with shell commands to execute
* @param string $sBuildDir full path of the build directory
* @param string $sOutFilename filename for output
* @return array * @return array
*/ */
public function getBuildCommands(){ public function getBuildCommands(){
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment