add function comments

spotbot2k · Jul 18, 2018 · 44845a5 · 44845a5
1 parent 850eeef
commit 44845a5
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/src/Resources/contao/classes/FontFaces.php b/src/Resources/contao/classes/FontFaces.php
@@ -40,6 +40,11 @@ public function updateFontFaces($dc)
         }
     }
 
+    /**
+     * Delete file while purging the font out of the database
+     *
+     * @param DataContainer $dc
+     */
     public function deleteFontFace($dc)
     {
         $fontName = $dc->activeRecord->name;
@@ -190,6 +195,13 @@ public function generateFilePath($fontName)
         return sprintf("bundles/spotwebfontgenerator/css/webfont-%s.css", $slug);
     }
 
+    /**
+     * Determine if a string is a relative path and if so
+     * convert it into a full URL
+     *
+     * @param string $strPath
+     * @return string
+     */
     private function pathToUrl($strPath)
     {
         if (filter_var($strPath, FILTER_VALIDATE_URL)) {

diff --git a/src/Resources/contao/classes/FontMaintenance.php b/src/Resources/contao/classes/FontMaintenance.php
@@ -7,6 +7,9 @@
 
 class FontMaintenance extends Backend
 {
+    /**
+     * Generate files only active fonts
+     */
     public function rebuildFontCSS()
     {
         $this->import('Database');
@@ -18,6 +21,9 @@ public function rebuildFontCSS()
         }
     }
 
+    /**
+     * Delete generated CSS files
+     */
     private function purgeFiles()
     {
         foreach (scandir(System::getContainer()->getParameter('kernel.project_dir').'/web/bundles/spotwebfontgenerator/css/') as $file) {