Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 2e81248

Browse filesBrowse files
javiereguiluzfabpot
javiereguiluz
authored and
fabpot
committed
Updated all the README files
1 parent d0cac39 commit 2e81248
Copy full SHA for 2e81248

File tree

Expand file treeCollapse file tree

32 files changed

+218
-1036
lines changed
Filter options
Expand file treeCollapse file tree

32 files changed

+218
-1036
lines changed

‎src/Symfony/Bridge/Doctrine/README.md

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Doctrine/README.md
+4-5Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ various Symfony components.
77
Resources
88
---------
99

10-
You can run the unit tests with the following command:
11-
12-
$ cd path/to/Symfony/Bridge/Doctrine/
13-
$ composer install
14-
$ phpunit
10+
* [Contributing](https://symfony.com/doc/current/contributing/index.html)
11+
* [Report issues](https://github.com/symfony/symfony/issues) and
12+
[send Pull Requests](https://github.com/symfony/symfony/pulls)
13+
in the [main Symfony repository](https://github.com/symfony/symfony)

‎src/Symfony/Bridge/Monolog/README.md

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Monolog/README.md
+4-5Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ Provides integration for Monolog with various Symfony components.
66
Resources
77
---------
88

9-
You can run the unit tests with the following command:
10-
11-
$ cd path/to/Symfony/Bridge/Monolog/
12-
$ composer install
13-
$ phpunit
9+
* [Contributing](https://symfony.com/doc/current/contributing/index.html)
10+
* [Report issues](https://github.com/symfony/symfony/issues) and
11+
[send Pull Requests](https://github.com/symfony/symfony/pulls)
12+
in the [main Symfony repository](https://github.com/symfony/symfony)

‎src/Symfony/Bridge/Propel1/README.md

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Propel1/README.md
+4-5Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ Provides integration for Propel with various Symfony components.
66
Resources
77
---------
88

9-
You can run the unit tests with the following command:
10-
11-
$ cd path/to/Symfony/Bridge/Propel1/
12-
$ composer install
13-
$ phpunit
9+
* [Contributing](https://symfony.com/doc/current/contributing/index.html)
10+
* [Report issues](https://github.com/symfony/symfony/issues) and
11+
[send Pull Requests](https://github.com/symfony/symfony/pulls)
12+
in the [main Symfony repository](https://github.com/symfony/symfony)

‎src/Symfony/Bridge/ProxyManager/README.md

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/ProxyManager/README.md
+4-5Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ Provides integration for [ProxyManager][1] with various Symfony components.
66
Resources
77
---------
88

9-
You can run the unit tests with the following command:
10-
11-
$ cd path/to/Symfony/Bridge/ProxyManager/
12-
$ composer install
13-
$ phpunit
9+
* [Contributing](https://symfony.com/doc/current/contributing/index.html)
10+
* [Report issues](https://github.com/symfony/symfony/issues) and
11+
[send Pull Requests](https://github.com/symfony/symfony/pulls)
12+
in the [main Symfony repository](https://github.com/symfony/symfony)
1413

1514
[1]: https://github.com/Ocramius/ProxyManager

‎src/Symfony/Bridge/Twig/README.md

Copy file name to clipboardExpand all lines: src/Symfony/Bridge/Twig/README.md
+4-6Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ Symfony components.
77
Resources
88
---------
99

10-
If you want to run the unit tests, install dev dependencies before
11-
running PHPUnit:
12-
13-
$ cd path/to/Symfony/Bridge/Twig/
14-
$ composer install
15-
$ phpunit
10+
* [Contributing](https://symfony.com/doc/current/contributing/index.html)
11+
* [Report issues](https://github.com/symfony/symfony/issues) and
12+
[send Pull Requests](https://github.com/symfony/symfony/pulls)
13+
in the [main Symfony repository](https://github.com/symfony/symfony)

‎src/Symfony/Component/BrowserKit/README.md

Copy file name to clipboard
+7-16Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,14 @@
11
BrowserKit Component
22
====================
33

4-
BrowserKit simulates the behavior of a web browser.
5-
6-
The component only provides an abstract client and does not provide any
7-
"default" backend for the HTTP layer.
4+
The BrowserKit component simulates the behavior of a web browser, allowing you
5+
to make requests, click on links and submit forms programmatically.
86

97
Resources
108
---------
119

12-
For a simple implementation of a browser based on an HTTP layer, have a look
13-
at [Goutte](https://github.com/FriendsOfPHP/Goutte).
14-
15-
For an implementation based on HttpKernelInterface, have a look at the
16-
[Client](https://github.com/symfony/symfony/blob/master/src/Symfony/Component/HttpKernel/Client.php)
17-
provided by the HttpKernel component.
18-
19-
You can run the unit tests with the following command:
20-
21-
$ cd path/to/Symfony/Component/BrowserKit/
22-
$ composer install
23-
$ phpunit
10+
* [Documentation](https://symfony.com/doc/current/components/browser_kit/introduction.html)
11+
* [Contributing](https://symfony.com/doc/current/contributing/index.html)
12+
* [Report issues](https://github.com/symfony/symfony/issues) and
13+
[send Pull Requests](https://github.com/symfony/symfony/pulls)
14+
in the [main Symfony repository](https://github.com/symfony/symfony)

‎src/Symfony/Component/ClassLoader/README.md

Copy file name to clipboard
+7-78Lines changed: 7 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,14 @@
11
ClassLoader Component
22
=====================
33

4-
ClassLoader loads your project classes automatically if they follow some
5-
standard PHP conventions.
6-
7-
The ClassLoader object is able to autoload classes that implement the PSR-0
8-
standard or the PEAR naming convention.
9-
10-
First, register the autoloader:
11-
12-
```php
13-
require_once __DIR__.'/src/Symfony/Component/ClassLoader/ClassLoader.php';
14-
15-
use Symfony\Component\ClassLoader\ClassLoader;
16-
17-
$loader = new ClassLoader();
18-
$loader->register();
19-
```
20-
21-
Then, register some namespaces with the `addPrefix()` method:
22-
23-
```php
24-
$loader->addPrefix('Symfony', __DIR__.'/src');
25-
$loader->addPrefix('Monolog', __DIR__.'/vendor/monolog/src');
26-
```
27-
28-
The `addPrefix()` method takes a namespace prefix and a path where to
29-
look for the classes as arguments.
30-
31-
You can also register a sub-namespaces:
32-
33-
```php
34-
$loader->addPrefix('Doctrine\\Common', __DIR__.'/vendor/doctrine-common/lib');
35-
```
36-
37-
The order of registration is significant and the first registered namespace
38-
takes precedence over later registered one.
39-
40-
You can also register more than one path for a given namespace:
41-
42-
```php
43-
$loader->addPrefix('Symfony', array(__DIR__.'/src', __DIR__.'/symfony/src'));
44-
```
45-
46-
Alternatively, you can use the `addPrefixes()` method to register more
47-
than one namespace at once:
48-
49-
```php
50-
$loader->addPrefixes(array(
51-
'Symfony' => array(__DIR__.'/src', __DIR__.'/symfony/src'),
52-
'Doctrine\\Common' => __DIR__.'/vendor/doctrine-common/lib',
53-
'Doctrine' => __DIR__.'/vendor/doctrine/lib',
54-
'Monolog' => __DIR__.'/vendor/monolog/src',
55-
));
56-
```
57-
58-
For better performance, you can use the APC class loader:
59-
60-
```php
61-
require_once __DIR__.'/src/Symfony/Component/ClassLoader/ClassLoader.php';
62-
require_once __DIR__.'/src/Symfony/Component/ClassLoader/ApcClassLoader.php';
63-
64-
use Symfony\Component\ClassLoader\ClassLoader;
65-
use Symfony\Component\ClassLoader\ApcClassLoader;
66-
67-
$loader = new ClassLoader();
68-
$loader->addPrefix('Symfony', __DIR__.'/src');
69-
70-
$loader = new ApcClassLoader('apc.prefix.', $loader);
71-
$loader->register();
72-
```
73-
74-
Furthermore, the component provides tools to aggregate classes into a single
75-
file, which is especially useful to improve performance on servers that do not
76-
provide byte caches.
4+
The ClassLoader component provides tools to autoload your classes and cache
5+
their locations for performance.
776

787
Resources
798
---------
809

81-
You can run the unit tests with the following command:
82-
83-
$ cd path/to/Symfony/Component/ClassLoader/
84-
$ composer install
85-
$ phpunit
10+
* [Documentation](https://symfony.com/doc/current/components/class_loader/index.html)
11+
* [Contributing](https://symfony.com/doc/current/contributing/index.html)
12+
* [Report issues](https://github.com/symfony/symfony/issues) and
13+
[send Pull Requests](https://github.com/symfony/symfony/pulls)
14+
in the [main Symfony repository](https://github.com/symfony/symfony)

‎src/Symfony/Component/Config/README.md

Copy file name to clipboard
+8-10Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
Config Component
22
================
33

4-
Config provides the infrastructure for loading configurations from different
5-
data sources and optionally monitoring these data sources for changes. There
6-
are additional tools for validating, normalizing and handling of defaults that
7-
can optionally be used to convert from different formats to arrays.
4+
The Config component provides several classes to help you find, load, combine,
5+
autofill and validate configuration values of any kind, whatever their source
6+
may be (YAML, XML, INI files, or for instance a database).
87

98
Resources
109
---------
1110

12-
You can run the unit tests with the following command:
13-
14-
$ cd path/to/Symfony/Component/Config/
15-
$ composer install
16-
$ phpunit
17-
11+
* [Documentation](https://symfony.com/doc/current/components/config/index.html)
12+
* [Contributing](https://symfony.com/doc/current/contributing/index.html)
13+
* [Report issues](https://github.com/symfony/symfony/issues) and
14+
[send Pull Requests](https://github.com/symfony/symfony/pulls)
15+
in the [main Symfony repository](https://github.com/symfony/symfony)

‎src/Symfony/Component/Console/README.md

Copy file name to clipboard
+11-58Lines changed: 11 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,20 @@
11
Console Component
22
=================
33

4-
Console eases the creation of beautiful and testable command line interfaces.
4+
The Console component eases the creation of beautiful and testable command line
5+
interfaces.
56

6-
The Application object manages the CLI application:
7-
8-
```php
9-
use Symfony\Component\Console\Application;
10-
11-
$console = new Application();
12-
$console->run();
13-
```
14-
15-
The ``run()`` method parses the arguments and options passed on the command
16-
line and executes the right command.
17-
18-
Registering a new command can easily be done via the ``register()`` method,
19-
which returns a ``Command`` instance:
20-
21-
```php
22-
use Symfony\Component\Console\Input\InputInterface;
23-
use Symfony\Component\Console\Input\InputArgument;
24-
use Symfony\Component\Console\Input\InputOption;
25-
use Symfony\Component\Console\Output\OutputInterface;
26-
27-
$console
28-
->register('ls')
29-
->setDefinition(array(
30-
new InputArgument('dir', InputArgument::REQUIRED, 'Directory name'),
31-
))
32-
->setDescription('Displays the files in the given directory')
33-
->setCode(function (InputInterface $input, OutputInterface $output) {
34-
$dir = $input->getArgument('dir');
35-
36-
$output->writeln(sprintf('Dir listing for <info>%s</info>', $dir));
37-
})
38-
;
39-
```
40-
41-
You can also register new commands via classes.
42-
43-
The component provides a lot of features like output coloring, input and
44-
output abstractions (so that you can easily unit-test your commands),
45-
validation, automatic help messages, ...
46-
47-
Tests
48-
-----
49-
50-
You can run the unit tests with the following command:
7+
Resources
8+
---------
519

52-
$ cd path/to/Symfony/Component/Console/
53-
$ composer install
54-
$ phpunit
10+
* [Documentation](https://symfony.com/doc/current/components/console/index.html)
11+
* [Contributing](https://symfony.com/doc/current/contributing/index.html)
12+
* [Report issues](https://github.com/symfony/symfony/issues) and
13+
[send Pull Requests](https://github.com/symfony/symfony/pulls)
14+
in the [main Symfony repository](https://github.com/symfony/symfony)
5515

56-
Third Party
57-
-----------
16+
Credits
17+
-------
5818

5919
`Resources/bin/hiddeninput.exe` is a third party binary provided within this
6020
component. Find sources and license at https://github.com/Seldaek/hidden-input.
61-
62-
Resources
63-
---------
64-
65-
[The Console Component](https://symfony.com/doc/current/components/console.html)
66-
67-
[How to create a Console Command](https://symfony.com/doc/current/cookbook/console/console_command.html)

‎src/Symfony/Component/CssSelector/README.md

Copy file name to clipboard
+10-37Lines changed: 10 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,20 @@
11
CssSelector Component
22
=====================
33

4-
CssSelector converts CSS selectors to XPath expressions.
5-
6-
The component only goal is to convert CSS selectors to their XPath
7-
equivalents:
8-
9-
```php
10-
use Symfony\Component\CssSelector\CssSelector;
11-
12-
print CssSelector::toXPath('div.item > h4 > a');
13-
```
14-
15-
HTML and XML are different
16-
--------------------------
17-
18-
The `CssSelector` component comes with an `HTML` extension which is enabled by
19-
default. If you need to use this component with `XML` documents, you have to
20-
disable this `HTML` extension. That's because, `HTML` tag & attribute names
21-
are always lower-cased, but case-sensitive in `XML`:
22-
23-
```php
24-
// disable `HTML` extension:
25-
CssSelector::disableHtmlExtension();
26-
27-
// re-enable `HTML` extension:
28-
CssSelector::enableHtmlExtension();
29-
```
30-
31-
When the `HTML` extension is enabled, tag names are lower-cased, attribute
32-
names are lower-cased, the following extra pseudo-classes are supported:
33-
`checked`, `link`, `disabled`, `enabled`, `selected`, `invalid`, `hover`,
34-
`visited`, and the `lang()` function is also added.
4+
The CssSelector component converts CSS selectors to XPath expressions.
355

366
Resources
377
---------
388

9+
* [Documentation](https://symfony.com/doc/current/components/css_selector.html)
10+
* [Contributing](https://symfony.com/doc/current/contributing/index.html)
11+
* [Report issues](https://github.com/symfony/symfony/issues) and
12+
[send Pull Requests](https://github.com/symfony/symfony/pulls)
13+
in the [main Symfony repository](https://github.com/symfony/symfony)
14+
15+
Credits
16+
-------
17+
3918
This component is a port of the Python cssselect library
4019
[v0.7.1](https://github.com/SimonSapin/cssselect/releases/tag/v0.7.1),
4120
which is distributed under the BSD license.
42-
43-
You can run the unit tests with the following command:
44-
45-
$ cd path/to/Symfony/Component/CssSelector/
46-
$ composer install
47-
$ phpunit

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.