Skip to content

[CssSelector] remove ConverterInterface #15988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 30, 2015
Merged

[CssSelector] remove ConverterInterface #15988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd3fefb
[CssSelector] remove ConverterInterface
fabpot Sep 29, 2015
8b8b634
[CssSelector] updated README
fabpot Sep 30, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Symfony/Component/CssSelector/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ CHANGELOG
2.8.0
-----

* Added the ConverterInterface and the Converter implementation as a non-static API for the component.
* Added the `CssSelectorConverter` class as a non-static API for the component.
* Deprecated the `CssSelector` static API of the component.

2.1.0
Expand Down
71 changes: 0 additions & 71 deletions src/Symfony/Component/CssSelector/ConverterInterface.php
View file
Open in desktop

This file was deleted.

15 changes: 13 additions & 2 deletions ...mfony/Component/CssSelector/Converter.php → ...nent/CssSelector/CssSelectorConverter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,12 @@
use Symfony\Component\CssSelector\XPath\Translator;

/**
* CssSelectorConverter is the main entry point of the component and can convert CSS
* selectors to XPath expressions.
*
* @author Christophe Coevoet <stof@notk.org>
*/
class Converter implements ConverterInterface
class CssSelectorConverter
{
private $translator;

Expand All @@ -45,7 +48,15 @@ public function __construct($html = true)
}

/**
* {@inheritdoc}
* Translates a CSS expression to its XPath equivalent.
*
* Optionally, a prefix can be added to the resulting XPath
* expression with the $prefix parameter.
*
* @param string $cssExpr The CSS expression.
* @param string $prefix An optional prefix for the XPath expression.
*
* @return string
*/
public function toXPath($cssExpr, $prefix = 'descendant-or-self::')
{
Expand Down
53 changes: 45 additions & 8 deletions src/Symfony/Component/CssSelector/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,23 @@ The component only goal is to convert CSS selectors to their XPath
equivalents:

```php
use Symfony\Component\CssSelector\CssSelector;
use Symfony\Component\CssSelector\CssSelectorConverter;

print CssSelector::toXPath('div.item > h4 > a');
$converter = new CssSelectorConverter();
print $converter->toXPath('div.item > h4 > a');
```

HTML and XML are different
--------------------------

The `CssSelector` component comes with an `HTML` extension which is enabled by
default. If you need to use this component with `XML` documents, you have to
disable this `HTML` extension. That's because, `HTML` tag & attribute names
are always lower-cased, but case-sensitive in `XML`:
disable this `HTML` extension. That's because, `HTML` tag & attribute names are
always lower-cased, but case-sensitive in `XML`:

```php
// disable `HTML` extension:
CssSelector::disableHtmlExtension();

// re-enable `HTML` extension:
CssSelector::enableHtmlExtension();
$converter = new CssSelectorConverter(false);
```

When the `HTML` extension is enabled, tag names are lower-cased, attribute
Expand All @@ -45,3 +43,42 @@ You can run the unit tests with the following command:
$ cd path/to/Symfony/Component/CssSelector/
$ composer install
$ phpunit

License
-------

This component is a port of the Python cssselect library,
which is copyright Ian Bicking, https://github.com/SimonSapin/cssselect.

Copyright (c) 2007-2012 Ian Bicking and contributors. See AUTHORS
for more details.

All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.

3. Neither the name of Ian Bicking nor the names of its contributors may
be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL IAN BICKING OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.