Update copyright and docblock strings

gordonknoppe · Nov 3, 2015 · 65f661c · 65f661c
1 parent 92d287a
commit 65f661c
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 13 deletions.
diff --git a/src/app/code/community/Guidance/Cachebuster/Helper/Data.php b/src/app/code/community/Guidance/Cachebuster/Helper/Data.php
@@ -2,7 +2,7 @@
 /**
  * NOTICE OF LICENSE
  *
- * Copyright 2012 Guidance Solutions
+ * Copyright 2015 Gordon Knoppe
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,24 +19,49 @@
  * @author     Gordon Knoppe
  * @category   Guidance
  * @package    Cachebuster
- * @copyright  Copyright (c) 2012 Guidance Solutions (http://www.guidance.com)
+ * @copyright  Copyright (c) 2015 Gordon Knoppe
  * @license   http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
  */
 
 class Guidance_Cachebuster_Helper_Data extends Mage_Core_Helper_Data
 {
-
+    /**
+     * Configuration path for module status
+     */
     const XML_PATH_IS_ENABLED = 'system/guidance_cachebuster/is_enabled';
+
+    /**
+     * Configuration path for supported file extensions
+     */
     const XML_PATH_FILE_EXTENSIONS = 'system/guidance_cachebuster/file_extensions';
+
+    /**
+     * Configuration path for URL keys
+     */
     const XML_PATH_FILE_URL_KEYS = 'system/guidance_cachebuster/url_keys';
 
-    protected $_fileExtensions;
+    /**
+     * File extensions cache
+     *
+     * @var array
+     */
+    protected $_fileExtensions = array();
 
+    /**
+     * Check if module is enabled
+     *
+     * @return mixed
+     */
     public function isEnabled()
     {
         return Mage::getStoreConfig(self::XML_PATH_IS_ENABLED);
     }
 
+    /**
+     * Get enabled file extensions
+     *
+     * @return array
+     */
     public function enabledFileExtensions()
     {
         if (is_null($this->_fileExtensions)) {
@@ -47,6 +72,8 @@ public function enabledFileExtensions()
     }
 
     /**
+     * Get configured string parser instance
+     *
      * @return Guidance_Cachebuster_Model_Parser
      */
     public function getParser()
@@ -72,6 +99,11 @@ public function getParser()
         return $parser;
     }
 
+    /**
+     * Get configured URL keys
+     *
+     * @return mixed
+     */
     protected function _getUrlKeys()
     {
         $urls = Mage::getStoreConfig(self::XML_PATH_FILE_URL_KEYS);

diff --git a/src/app/code/community/Guidance/Cachebuster/Model/Observer.php b/src/app/code/community/Guidance/Cachebuster/Model/Observer.php
@@ -2,7 +2,7 @@
 /**
  * NOTICE OF LICENSE
  *
- * Copyright 2012 Guidance Solutions
+ * Copyright 2015 Gordon Knoppe
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@
  * @author     Gordon Knoppe
  * @category   Guidance
  * @package    Cachebuster
- * @copyright  Copyright (c) 2012 Guidance Solutions (http://www.guidance.com)
+ * @copyright  Copyright (c) 2015 Gordon Knoppe
  * @license   http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
  */
 

diff --git a/src/app/code/community/Guidance/Cachebuster/Model/Parser.php b/src/app/code/community/Guidance/Cachebuster/Model/Parser.php
@@ -11,7 +11,11 @@ class Guidance_Cachebuster_Model_Parser
     /** @var array  */
     protected $_maps = array();
 
-    /** @var array  */
+    /**
+     * File extensions cache
+     *
+     * @var array
+     */
     protected $_fileExtensions = array();
 
     /**
@@ -121,6 +125,8 @@ protected function _sanitizeUrl($url)
     }
 
     /**
+     * Parse URLs in given string
+     *
      * @param string $html
      * @return array
      */

diff --git a/src/app/code/community/Guidance/Cachebuster/etc/config.xml b/src/app/code/community/Guidance/Cachebuster/etc/config.xml
@@ -3,7 +3,7 @@
 /**
  * NOTICE OF LICENSE
  *
- * Copyright 2012 Guidance Solutions
+ * Copyright 2015 Gordon Knoppe
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@
  * @author     Gordon Knoppe
  * @category   Guidance
  * @package    Cachebuster
- * @copyright  Copyright (c) 2012 Guidance Solutions (http://www.guidance.com)
+ * @copyright  Copyright (c) 2015 Gordon Knoppe
  * @license   http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
  */
  -->

diff --git a/src/app/code/community/Guidance/Cachebuster/etc/system.xml b/src/app/code/community/Guidance/Cachebuster/etc/system.xml
@@ -3,7 +3,7 @@
 /**
  * NOTICE OF LICENSE
  *
- * Copyright 2012 Guidance Solutions
+ * Copyright 2015 Gordon Knoppe
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@
  * @author     Gordon Knoppe
  * @category   Guidance
  * @package    Cachebuster
- * @copyright  Copyright (c) 2012 Guidance Solutions (http://www.guidance.com)
+ * @copyright  Copyright (c) 2015 Gordon Knoppe
  * @license   http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
  */
  -->

diff --git a/src/app/etc/modules/Guidance_Cachebuster.xml b/src/app/etc/modules/Guidance_Cachebuster.xml
@@ -3,7 +3,7 @@
 /**
  * NOTICE OF LICENSE
  *
- * Copyright 2012 Guidance Solutions
+ * Copyright 2015 Gordon Knoppe
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@
  * @author     Gordon Knoppe
  * @category   Guidance
  * @package    Cachebuster
- * @copyright  Copyright (c) 2012 Guidance Solutions (http://www.guidance.com)
+ * @copyright  Copyright (c) 2015 Gordon Knoppe
  * @license   http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
  */
  -->