[2.0][Component][ClassLoader] cs

Updated LICENSE files copyright
[ClassLoader] Update PSR-0 reference.
2026-04-25 09:48:05 +02:00 · 2012-04-23 07:37:21 +02:00 · 2012-02-22 10:10:37 +01:00 · 2012-01-11 09:27:00 +05:45 · 2012-01-05 14:51:20 +01:00 · 2011-12-18 14:22:28 +01:00
6 changed files with 68 additions and 7 deletions
@@ -17,7 +17,7 @@ namespace Symfony\Component\ClassLoader;
 * It is able to load classes that use either:
 *
 *  * The technical interoperability standards for PHP 5.3 namespaces and
- *    class names (http://groups.google.com/group/php-standards/web/psr-0-final-proposal);
+ *    class names (https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md);
 *
 *  * The PEAR naming convention for classes (http://pear.php.net/).
 *
@@ -84,6 +84,8 @@ class ApcUniversalClassLoader extends UniversalClassLoader
     * Finds a file by class name while caching lookups to APC.
     *
     * @param string $class A class name to resolve to file
+     *
+     * @return string|null The path, if found
     */
    public function findFile($class)
    {
@@ -172,7 +172,7 @@ class ClassCollectionLoader
    /**
     * Writes a cache file.
     *
-     * @param string $file Filename
+     * @param string $file    Filename
     * @param string $content Temporary file content
     *
     * @throws \RuntimeException when a cache file cannot be written
@@ -1,4 +1,4 @@
-Copyright (c) 2004-2011 Fabien Potencier
+Copyright (c) 2004-2012 Fabien Potencier

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -0,0 +1,60 @@
+ClassLoader Component
+=====================
+
+ClassLoader loads your project classes automatically if they follow some
+standard PHP conventions.
+
+The Universal ClassLoader is able to autoload classes that implement the PSR-0
+standard or the PEAR naming convention.
+
+First, register the autoloader:
+
+    require_once __DIR__.'/src/Symfony/Component/ClassLoader/UniversalClassLoader.php';
+
+    use Symfony\Component\ClassLoader\UniversalClassLoader;
+
+    $loader = new UniversalClassLoader();
+    $loader->register();
+
+Then, register some namespaces with the `registerNamespace()` method:
+
+    $loader->registerNamespace('Symfony', __DIR__.'/src');
+    $loader->registerNamespace('Monolog', __DIR__.'/vendor/monolog/src');
+
+The `registerNamespace()` method takes a namespace prefix and a path where to
+look for the classes as arguments.
+
+You can also register a sub-namespaces:
+
+    $loader->registerNamespace('Doctrine\\Common', __DIR__.'/vendor/doctrine-common/lib');
+
+The order of registration is significant and the first registered namespace
+takes precedence over later registered one.
+
+You can also register more than one path for a given namespace:
+
+    $loader->registerNamespace('Symfony', array(__DIR__.'/src', __DIR__.'/symfony/src'));
+
+Alternatively, you can use the `registerNamespaces()` method to register more
+than one namespace at once:
+
+    $loader->registerNamespaces(array(
+        'Symfony'          => array(__DIR__.'/src', __DIR__.'/symfony/src'),
+        'Doctrine\\Common' => __DIR__.'/vendor/doctrine-common/lib',
+        'Doctrine'         => __DIR__.'/vendor/doctrine/lib',
+        'Monolog'          => __DIR__.'/vendor/monolog/src',
+    ));
+
+For better performance, you can use the APC based version of the universal
+class loader:
+
+    require_once __DIR__.'/src/Symfony/Component/ClassLoader/UniversalClassLoader.php';
+    require_once __DIR__.'/src/Symfony/Component/ClassLoader/ApcUniversalClassLoader.php';
+
+    use Symfony\Component\ClassLoader\ApcUniversalClassLoader;
+
+    $loader = new ApcUniversalClassLoader('apc.prefix.');
+
+Furthermore, the component provides tools to aggregate classes into a single
+file, which is especially useful to improve performance on servers that do not
+provide byte caches.
@@ -17,7 +17,7 @@ namespace Symfony\Component\ClassLoader;
 * It is able to load classes that use either:
 *
 *  * The technical interoperability standards for PHP 5.3 namespaces and
- *    class names (http://groups.google.com/group/php-standards/web/psr-0-final-proposal);
+ *    class names (https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md);
 *
 *  * The PEAR naming convention for classes (http://pear.php.net/).
 *
@@ -169,8 +169,8 @@ class UniversalClassLoader
    /**
     * Registers a set of classes using the PEAR naming convention.
     *
-     * @param string       $prefix  The classes prefix
-     * @param array|string $paths   The location(s) of the classes
+     * @param string       $prefix The classes prefix
+     * @param array|string $paths  The location(s) of the classes
     *
     * @api
     */
@@ -4,7 +4,6 @@
    "description": "Symfony ClassLoader Component",
    "keywords": [],
    "homepage": "http://symfony.com",
-    "version": "2.0.7",
    "license": "MIT",
    "authors": [
        {
Author	SHA1	Message	Date
Włodzimierz Gajda	6329e84c2d	[2.0][Component][ClassLoader] cs	2012-04-23 07:37:21 +02:00
marc.weistroff	28bf7c891b	Updated LICENSE files copyright	2012-02-22 10:10:37 +01:00
Drak	1c055115cc	[ClassLoader] Update PSR-0 reference.	2012-01-11 09:27:00 +05:45
Fabien Potencier	58e364c99c	removed the version attribute in all composer.json files	2012-01-05 14:51:20 +01:00
Fabien Potencier	788001eb1a	tweaked the README files	2011-12-18 14:22:28 +01:00
Fabien Potencier	67f0ac3a3b	merged branch lsmith77/component_readmes (PR #2561 ) Commits ------- 1e370d7 typo fix 93d8d44 added some more infos about Config 27efd59 added READMEs for the bridges 34fc866 cosmetic tweaks d6af3f1 fixed README for Console 6a72b8c added basic README files for all components Discussion ---------- added basic README files for all components and bridges heavily based on http://fabien.potencier.org/article/49/what-is-symfony2 and the official Symfony2 documentation --------------------------------------------------------------------------- by jmikola at 2011/11/03 13:36:07 -0700 Great work. For syntax highlighting on the PHP snippets, you could add "php" after the three backticks. --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:41:29 -0700 done --------------------------------------------------------------------------- by stealth35 at 2011/11/03 13:49:31 -0700 Nice job, but you also need to add `<?php` ex : ``` php <?php use Symfony\Component\DomCrawler\Crawler; $crawler = new Crawler(); $crawler->addContent('<html><body><p>Hello World!</p></body></html>'); print $crawler->filter('body > p')->text(); ``` --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:56:57 -0700 done --------------------------------------------------------------------------- by ericclemmons at 2011/11/03 19:57:57 -0700 @lsmith77 Well done! This makes consumption of individual components that much easier, especially now that `composer.json` files have been added. --------------------------------------------------------------------------- by lsmith77 at 2011/11/04 01:18:23 -0700 ok .. fixed the issues you mentioned @fabpot --------------------------------------------------------------------------- by lsmith77 at 2011/11/11 15:00:27 -0800 @fabpot anything else left? seems like an easy merge .. and imho there is considerable benefit for our efforts to spread the word about the components with this PR merged. --------------------------------------------------------------------------- by drak at 2011/11/11 18:54:13 -0800 You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com --------------------------------------------------------------------------- by lsmith77 at 2011/11/12 00:59:14 -0800 i did that in some. but i might have missed a few places. On 12.11.2011, at 03:54, Drak <reply@reply.github.com> wrote: > You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com > > --- > Reply to this email directly or view it on GitHub: > https://github.com/symfony/symfony/pull/2561#issuecomment-2715762 --------------------------------------------------------------------------- by breerly at 2011/11/21 10:28:36 -0800 Pretty excited with this. --------------------------------------------------------------------------- by dbu at 2011/11/24 00:02:50 -0800 is there anything we can help with to make this ready to be merged? --------------------------------------------------------------------------- by lsmith77 at 2011/12/18 02:39:23 -0800 @fabpot: seriously .. if you are not going to deliver something "better" and don't provide a reason what is wrong with this .. then its beyond frustrating. i obviously do not claim that these README's are perfect (and certainly still no replacement for proper documentation), but I do claim that in their current form they are a radical step forward to potential users of the Symfony2 components.	2011-12-18 12:42:02 +01:00
Lukas Kahwe Smith	a0c2e07078	added basic README files for all components heavily inspired by http://fabien.potencier.org/article/49/what-is-symfony2 and the official Symfony2 documentation	2011-11-03 21:11:40 +01:00