Minor code cleanup: PHPDoc, spelling, unused variables, etc.

[github/shaarli/Shaarli.git] / application / ApplicationUtils.php

diff --git a/application/ApplicationUtils.php b/application/ApplicationUtils.php
index 37deb4b3fd50540fe4d62a519cf83242c5262aad..7f963e9786cc50901863789341bc802ed1e22403 100644 (file)
--- a/application/ApplicationUtils.php
+++ b/application/ApplicationUtils.php
@@ -15,6 +15,9 @@ class ApplicationUtils
      *
      * The code is read from the raw content of the version file on the Git server.
      *
+     * @param string $url     URL to reach to get the latest version.
+     * @param int    $timeout Timeout to check the URL (in seconds).
+     *
      * @return mixed the version code from the repository if available, else 'false'
      */
     public static function getLatestGitVersionCode($url, $timeout=2)
@@ -49,6 +52,7 @@ class ApplicationUtils
      * @param int    $checkInterval  the minimum interval between update checks (in seconds
      * @param bool   $enableCheck    whether to check for new versions
      * @param bool   $isLoggedIn     whether the user is logged in
+     * @param string $branch         check update for the given branch
      *
      * @throws Exception an invalid branch has been set for update checks
      *
@@ -132,31 +136,32 @@ class ApplicationUtils
     /**
      * Checks Shaarli has the proper access permissions to its resources
      *
+     * @param ConfigManager $conf Configuration Manager instance.
+     *
      * @return array A list of the detected configuration issues
      */
-    public static function checkResourcePermissions()
+    public static function checkResourcePermissions($conf)
     {
         $errors = array();
-        $conf = ConfigManager::getInstance();
 
         // Check script and template directories are readable
         foreach (array(
             'application',
             'inc',
             'plugins',
-            $conf->get('path.raintpl_tpl'),
+            $conf->get('resource.raintpl_tpl'),
         ) as $path) {
             if (! is_readable(realpath($path))) {
                 $errors[] = '"'.$path.'" directory is not readable';
             }
         }
 
-        // Check cache and data directories are readable and writeable
+        // Check cache and data directories are readable and writable
         foreach (array(
-            $conf->get('path.thumbnails_cache'),
-            $conf->get('path.data_dir'),
-            $conf->get('path.page_cache'),
-            $conf->get('path.raintpl_tmp'),
+            $conf->get('resource.thumbnails_cache'),
+            $conf->get('resource.data_dir'),
+            $conf->get('resource.page_cache'),
+            $conf->get('resource.raintpl_tmp'),
         ) as $path) {
             if (! is_readable(realpath($path))) {
                 $errors[] = '"'.$path.'" directory is not readable';
@@ -166,13 +171,13 @@ class ApplicationUtils
             }
         }
 
-        // Check configuration files are readable and writeable
+        // Check configuration files are readable and writable
         foreach (array(
-            $conf->getConfigFile(),
-            $conf->get('path.datastore'),
-            $conf->get('path.ban_file'),
-            $conf->get('path.log'),
-            $conf->get('path.update_check'),
+            $conf->getConfigFileExt(),
+            $conf->get('resource.datastore'),
+            $conf->get('resource.ban_file'),
+            $conf->get('resource.log'),
+            $conf->get('resource.update_check'),
         ) as $path) {
             if (! is_file(realpath($path))) {
                 # the file may not exist yet