Docblocks and J version markers

elkuku · Apr 27, 2012 · ff09164 · ff09164
1 parent 9cc13fa
commit ff09164
Show file tree

Hide file tree

Showing 35 changed files with 193 additions and 149 deletions.
diff --git a/administrator/components/com_easycreator/controllers/stuffer.php b/administrator/components/com_easycreator/controllers/stuffer.php
@@ -571,8 +571,9 @@ public function delete_project($complete = false)
         //-- Get the project
         try
         {
-            $project = EcrProjectHelper::getProject()
-                ->remove($complete);
+            $project = EcrProjectHelper::getProject();
+
+            $project->remove($complete);
 
             $this->setRedirect('index.php?option=com_easycreator'
                 , sprintf(jgettext('The Project %s has been removed'), $project->name));

diff --git a/administrator/components/com_easycreator/helpers/dbadapter/format/mysql.php b/administrator/components/com_easycreator/helpers/dbadapter/format/mysql.php
@@ -1,8 +1,8 @@
 <?php
 /**
- * Created by JetBrains PhpStorm.
- * User: elkuku
- * Date: 14.01.12
- * Time: 03:27
- * To change this template use File | Settings | File Templates.
+ * @package    EasyCreator
+ * @subpackage Helpers
+ * @author     Nikolai Plath (elkuku)
+ * @author     Created on 25-Apr-2011
+ * @license    GNU/GPL, see JROOT/LICENSE.php
  */
diff --git a/administrator/components/com_easycreator/helpers/dbadapter/format/postgresql.php b/administrator/components/com_easycreator/helpers/dbadapter/format/postgresql.php
@@ -1,8 +1,8 @@
 <?php
 /**
- * Created by JetBrains PhpStorm.
- * User: elkuku
- * Date: 14.01.12
- * Time: 04:53
- * To change this template use File | Settings | File Templates.
+ * @package    EasyCreator
+ * @subpackage Helpers
+ * @author     Nikolai Plath (elkuku)
+ * @author     Created on 25-Apr-2011
+ * @license    GNU/GPL, see JROOT/LICENSE.php
  */
diff --git a/administrator/components/com_easycreator/helpers/dbadapter/format/sqlite.php b/administrator/components/com_easycreator/helpers/dbadapter/format/sqlite.php
@@ -1,8 +1,8 @@
 <?php
 /**
- * Created by JetBrains PhpStorm.
- * User: elkuku
- * Date: 14.01.12
- * Time: 03:27
- * To change this template use File | Settings | File Templates.
+ * @package    EasyCreator
+ * @subpackage Helpers
+ * @author     Nikolai Plath (elkuku)
+ * @author     Created on 25-Apr-2011
+ * @license    GNU/GPL, see JROOT/LICENSE.php
  */
diff --git a/administrator/components/com_easycreator/helpers/dbadapter/format/sqlsrv.php b/administrator/components/com_easycreator/helpers/dbadapter/format/sqlsrv.php
@@ -1,8 +1,8 @@
 <?php
 /**
- * Created by JetBrains PhpStorm.
- * User: elkuku
- * Date: 14.01.12
- * Time: 04:53
- * To change this template use File | Settings | File Templates.
+ * @package    EasyCreator
+ * @subpackage Helpers
+ * @author     Nikolai Plath (elkuku)
+ * @author     Created on 25-Apr-2011
+ * @license    GNU/GPL, see JROOT/LICENSE.php
  */
diff --git a/administrator/components/com_easycreator/helpers/deployer/type/ftp.php b/administrator/components/com_easycreator/helpers/deployer/type/ftp.php
@@ -1,10 +1,10 @@
-<?php
+<?php defined('_JEXEC') || die('=;)');
 /**
- * Created by JetBrains PhpStorm.
- * User: elkuku
- * Date: 24.04.12
- * Time: 11:28
- * To change this template use File | Settings | File Templates.
+ * @package    EasyCreator
+ * @subpackage Helpers
+ * @author     Nikolai Plath (elkuku)
+ * @author     Created on 25-Apr-2011
+ * @license    GNU/GPL, see JROOT/LICENSE.php
  */
 
 class EcrDeployerTypeFtp extends EcrDeployer

diff --git a/administrator/components/com_easycreator/helpers/deployer/type/github.php b/administrator/components/com_easycreator/helpers/deployer/type/github.php
@@ -1,10 +1,14 @@
-<?php
+<?php defined('_JEXEC') || die('=;)');
 /**
- * Created by JetBrains PhpStorm.
- * User: elkuku
- * Date: 24.04.12
- * Time: 11:43
- * To change this template use File | Settings | File Templates.
+ * @package    EasyCreator
+ * @subpackage Helpers
+ * @author     Nikolai Plath (elkuku)
+ * @author     Created on 25-Apr-2011
+ * @license    GNU/GPL, see JROOT/LICENSE.php
+ */
+
+/**
+ *
  */
 class EcrDeployerTypeGithub extends EcrDeployer
 {

diff --git a/administrator/components/com_easycreator/helpers/ftp.php b/administrator/components/com_easycreator/helpers/ftp.php
@@ -1,10 +1,10 @@
 <?php
 /**
- * Created by JetBrains PhpStorm.
- * User: elkuku
- * Date: 18.04.12
- * Time: 16:15
- * To change this template use File | Settings | File Templates.
+ * @package    EasyCreator
+ * @subpackage Helpers
+ * @author     Nikolai Plath (elkuku)
+ * @author     Created on 25-Apr-2011
+ * @license    GNU/GPL, see JROOT/LICENSE.php
  */
 
 jimport('joomla.client.ftp');

diff --git a/administrator/components/com_easycreator/helpers/github.php b/administrator/components/com_easycreator/helpers/github.php
@@ -1,10 +1,10 @@
 <?php
 /**
- * Created by JetBrains PhpStorm.
- * User: elkuku
- * Date: 17.04.12
- * Time: 13:25
- * To change this template use File | Settings | File Templates.
+ * @package    EasyCreator
+ * @subpackage Helpers
+ * @author     Nikolai Plath (elkuku)
+ * @author     Created on 25-Apr-2011
+ * @license    GNU/GPL, see JROOT/LICENSE.php
  *
  * @property-read EcrGithubDownloads $downloads
  */

diff --git a/administrator/components/com_easycreator/helpers/github/downloads.php b/administrator/components/com_easycreator/helpers/github/downloads.php
@@ -1,10 +1,10 @@
-<?php
+<?php defined('_JEXEC') || die('=;)');
 /**
- * Created by JetBrains PhpStorm.
- * User: elkuku
- * Date: 17.04.12
- * Time: 13:37
- * To change this template use File | Settings | File Templates.
+ * @package    EasyCreator
+ * @subpackage Helpers
+ * @author     Nikolai Plath (elkuku)
+ * @author     Created on 25-Apr-2011
+ * @license    GNU/GPL, see JROOT/LICENSE.php
  */
 
 /**

diff --git a/administrator/components/com_easycreator/helpers/github/http.php b/administrator/components/com_easycreator/helpers/github/http.php
@@ -1,12 +1,15 @@
-<?php
+<?php defined('_JEXEC') || die('=;)');
 /**
- * Created by JetBrains PhpStorm.
- * User: elkuku
- * Date: 18.04.12
- * Time: 17:56
- * To change this template use File | Settings | File Templates.
+ * @package    EasyCreator
+ * @subpackage Helpers
+ * @author     Nikolai Plath (elkuku)
+ * @author     Created on 25-Apr-2011
+ * @license    GNU/GPL, see JROOT/LICENSE.php
  */
 
+/**
+ *
+ */
 class EcrGithubHttp extends JGithubHttp
 {
     /**

diff --git a/administrator/components/com_easycreator/helpers/github/response/downloads/get.php b/administrator/components/com_easycreator/helpers/github/response/downloads/get.php
@@ -1,10 +1,10 @@
-<?php
+<?php defined('_JEXEC') || die('=;)');
 /**
- * Created by JetBrains PhpStorm.
- * User: elkuku
- * Date: 17.04.12
- * Time: 17:08
- * To change this template use File | Settings | File Templates.
+ * @package    EasyCreator
+ * @subpackage Helpers
+ * @author     Nikolai Plath (elkuku)
+ * @author     Created on 25-Apr-2011
+ * @license    GNU/GPL, see JROOT/LICENSE.php
  */
 
 /**

diff --git a/administrator/components/com_easycreator/helpers/language.php b/administrator/components/com_easycreator/helpers/language.php
@@ -1111,6 +1111,7 @@ private function _buildFileList()
             if(JFolder::exists($copyItem))
             {
                 //--Add all PHP and XML files from a given folder
+                //-- @Joomla!-version-check
                 switch($this->project->JCompat)
                 {
                     case '1.5' :
@@ -1487,6 +1488,7 @@ public static function createFileFromRequest()
 
         $fileName = self::getFileName($lang, $scope, $project);
 
+        //-- @Joomla!-compat 1.5
         $commentChar =($project->JCompat == '1.5') ? '#' : ';';
 
         $fileContents = '';

diff --git a/administrator/components/com_easycreator/helpers/project/base.php b/administrator/components/com_easycreator/helpers/project/base.php
@@ -17,6 +17,11 @@ abstract class EcrProjectBase
 
     public $method = '';
 
+    /**
+     * Joomla! compatibility mode
+     * @Joomla!-compat 1.5
+     * @var string
+     */
     public $JCompat = '1.5';
 
     public $phpVersion = '4';
@@ -906,7 +911,10 @@ private function readProjectXml($projectName)
         $this->scope = (string)$manifest->attributes()->scope;
         $this->name = (string)$manifest->name;
         $this->comName = (string)$manifest->comname;
+
+        //-- @Joomla!-compat 1.5
         $this->JCompat = ((string)$manifest->JCompat) ? (string)$manifest->JCompat : '1.5';
+
         $this->langFormat = (string)$manifest->langFormat;
         $this->zipPath = (string)$manifest->zipPath;
         $this->headerType = (string)$manifest->headerType;

diff --git a/administrator/components/com_easycreator/helpers/project/manifest.php b/administrator/components/com_easycreator/helpers/project/manifest.php
@@ -49,17 +49,19 @@ public function create(EcrProjectBase $project)
 
         $rootTag = '';
 
+        //-- @Joomla!-version-check
         switch($this->project->JCompat)
         {
+            case '1.5':
+                $rootTag = 'install';
+                break;
+
             case '1.6':
             case '1.7':
             case '2.5':
                 $rootTag = 'extension';
                 break;
 
-            case '1.5':
-                $rootTag = 'install';
-                break;
             default:
                 JFactory::getApplication()->enqueueMessage(
                     __METHOD__.'Unknown JCompat: '.$this->project->JCompat, 'error');
@@ -233,6 +235,7 @@ private function processInstall()
         $installFiles = EcrProjectHelper::findInstallFiles($this->project);
 
         //-- PHP install scripts
+        //-- @Joomla!-version-check
         switch($this->project->JCompat)
         {
             case '1.5':
@@ -258,11 +261,13 @@ private function processInstall()
         $uninstall = $this->manifest->addChild('uninstall');
         $uninstallSql = $uninstall->addChild('sql');
 
+        //-- @Joomla!-version-check
         switch($this->project->JCompat)
         {
             case '1.6':
             case '1.7':
-                //-- J! 1.6 update stuff
+            case '2.5':
+                //-- J! 1.6+ update stuff
                 $update = $this->manifest->addChild('update');
                 $updateSql = $update->addChild('schemas');
 
@@ -279,6 +284,8 @@ private function processInstall()
                 break;
 
             default:
+                JFactory::getApplication()->enqueueMessage(
+                    __METHOD__.'Unknown JCompat: '.$this->project->JCompat, 'error');
                 break;
         }
 
@@ -475,6 +482,7 @@ private function processSite()
             }
         }
 
+        //-- @Joomla!-compat 1.5
         if(count($languageFiles)
             && $this->project->JCompat == '1.5'
         )
@@ -539,6 +547,7 @@ private function processAdmin()
                     $menu->addAttribute('img', $s);
                 }
 
+                //-- @Joomla!-compat 1.5
                 if(isset($def_menu['link'])
                     && $this->project->JCompat == '1.5'
                 )
@@ -578,6 +587,7 @@ private function processAdmin()
                         $menu->addAttribute('img', $s);
                     }
 
+                    //-- @Joomla!-version-check
                     switch($this->project->JCompat)
                     {
                         case '1.5' :
@@ -644,6 +654,7 @@ private function processAdmin()
             }
         }
 
+        //-- @Joomla!-compat 1.5
         if(count($languageFiles)
             && $this->project->JCompat == '1.5'
         )
@@ -800,6 +811,7 @@ private function processParameters()
 
             if('template' == $this->project->type)
             {
+                //-- @Joomla!-version-check
                 switch($this->project->JCompat)
                 {
                     case '1.5':

diff --git a/administrator/components/com_easycreator/helpers/project/type/cliapp.php b/administrator/components/com_easycreator/helpers/project/type/cliapp.php
@@ -22,6 +22,7 @@ class EcrProjectTypeCliapp extends EcrProjectBase
      */
     public $prefix = 'cap_';
 
+    //-- @Joomla!-compat 1.6
     public $JCompat = '1.6';
 
     /**

diff --git a/administrator/components/com_easycreator/helpers/project/type/component.php b/administrator/components/com_easycreator/helpers/project/type/component.php
@@ -124,6 +124,7 @@ public function getLanguagePaths($scope = '')
             return $paths;
         }
 
+        //-- @Joomla!-version-check
         switch($this->JCompat)
         {
             case '1.5':

diff --git a/administrator/components/com_easycreator/helpers/project/type/library.php b/administrator/components/com_easycreator/helpers/project/type/library.php
@@ -29,6 +29,7 @@ class EcrProjectTypeLibrary extends EcrProjectBase
      */
     public $prefix = 'lib_';
 
+    //-- @Joomla!-compat 1.6
     public $JCompat = '1.6';
 
     /**

diff --git a/administrator/components/com_easycreator/helpers/project/type/webapp.php b/administrator/components/com_easycreator/helpers/project/type/webapp.php
@@ -22,6 +22,7 @@ class EcrProjectTypeWebapp extends EcrProjectBase
      */
     public $prefix = 'wap_';
 
+    //-- @Joomla!-compat 1.6
     public $JCompat = '1.6';
 
     /**

diff --git a/administrator/components/com_easycreator/templates/parts/various/install_script/part.php b/administrator/components/com_easycreator/templates/parts/various/install_script/part.php
@@ -41,14 +41,14 @@ public function getOptions()
     {
         $project = EcrProjectHelper::getProject();
 
+        //-- @Joomla!-compat 1.5
         if('1.5' == $project->JCompat)
         {
-            EcrHtml::displayMessage(jgettext('Install scripts are avilable from Joomla! 1.6 + projects'), 'error');
+            EcrHtml::displayMessage(jgettext('Install scripts are available for Joomla! 1.6 + projects only'), 'error');
 
             return false;
         }
 
-//        var_dump($project);
         $ecr_project = JRequest::getCmd('ecr_project');
         $basePathDest = JPATH_ROOT.DS.'administrator'.DS.'components'.DS.$ecr_project;
 
@@ -62,6 +62,8 @@ public function getOptions()
         EcrHtml::drawLoggingOptions();
 
         EcrHtml::drawSubmitParts();
+
+        return $this;
     }//function
 
     /**

diff --git a/administrator/components/com_easycreator/version.txt b/administrator/components/com_easycreator/version.txt
@@ -1 +1 @@
-0.0.16-23-g5acf544
+0.0.16-24-g9cc13fa