From 108efc6ec96d88092daa67d139e88ab883792a87 Mon Sep 17 00:00:00 2001 From: Tim Nagel Date: Sun, 6 Feb 2011 13:31:19 -0800 Subject: [PATCH] Classloader PHPDoc --- .../Component/ClassLoader/ClassCollectionLoader.php | 13 +++++++++++++ .../Component/ClassLoader/MapFileClassLoader.php | 6 ++++++ .../Component/ClassLoader/UniversalClassLoader.php | 4 ++-- 3 files changed, 21 insertions(+), 2 deletions(-) diff --git a/src/Symfony/Component/ClassLoader/ClassCollectionLoader.php b/src/Symfony/Component/ClassLoader/ClassCollectionLoader.php index 62e9f4f5df..0773eb747a 100644 --- a/src/Symfony/Component/ClassLoader/ClassCollectionLoader.php +++ b/src/Symfony/Component/ClassLoader/ClassCollectionLoader.php @@ -119,6 +119,10 @@ class ClassCollectionLoader /** * Adds brackets around each namespace if it's not already the case. + * + * @param string Namespace string + * + * @return string Namespaces with brackets */ static public function fixNamespaceDeclarations($source) { @@ -162,6 +166,15 @@ class ClassCollectionLoader return $output; } + /** + * Writes a cache file + * + * @param string Filename + * @param string Temporary file content + * + * @throws \RuntimeException when a cache file cannot be written + */ + static protected function writeCacheFile($file, $content) { $tmpFile = tempnam(dirname($file), basename($file)); diff --git a/src/Symfony/Component/ClassLoader/MapFileClassLoader.php b/src/Symfony/Component/ClassLoader/MapFileClassLoader.php index 8a370af645..1cce5e22a6 100644 --- a/src/Symfony/Component/ClassLoader/MapFileClassLoader.php +++ b/src/Symfony/Component/ClassLoader/MapFileClassLoader.php @@ -12,6 +12,7 @@ namespace Symfony\Component\ClassLoader; /** + * A class loader that uses a mapping file to look up paths. * * @author Fabien Potencier */ @@ -19,6 +20,11 @@ class MapFileClassLoader { protected $map = array(); + /** + * Constructor + * + * @param string Path to class mapping file + */ public function __construct($file) { $this->map = require $file; diff --git a/src/Symfony/Component/ClassLoader/UniversalClassLoader.php b/src/Symfony/Component/ClassLoader/UniversalClassLoader.php index 55d3527d57..0394fa496e 100644 --- a/src/Symfony/Component/ClassLoader/UniversalClassLoader.php +++ b/src/Symfony/Component/ClassLoader/UniversalClassLoader.php @@ -102,7 +102,7 @@ class UniversalClassLoader /** * Registers the directory to use as a fallback for namespaces. * - * @return string|array $dirs A directory path or an array of directories + * @param string|array $dirs A directory path or an array of directories */ public function registerNamespaceFallback($dirs) { @@ -112,7 +112,7 @@ class UniversalClassLoader /** * Registers the directory to use as a fallback for class prefixes. * - * @return string|array $dirs A directory path or an array of directories + * @param string|array $dirs A directory path or an array of directories */ public function registerPrefixFallback($dirs) {