From 44845a59fdc305ee848989982e2f2c9a0385a256 Mon Sep 17 00:00:00 2001 From: Alexander Schwirjow Date: Wed, 18 Jul 2018 08:09:00 +0200 Subject: [PATCH] add function comments --- src/Resources/contao/classes/FontFaces.php | 12 ++++++++++++ src/Resources/contao/classes/FontMaintenance.php | 6 ++++++ 2 files changed, 18 insertions(+) diff --git a/src/Resources/contao/classes/FontFaces.php b/src/Resources/contao/classes/FontFaces.php index e295672..890155c 100644 --- 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 index 2589357..75d4ea2 100644 --- 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) {