added html-to-markdown package https://github.com/thephpleague/html-to-markdown
This commit is contained in:
Paul Kirby
parent
8afabfc7e8
commit
ac940f06fb
29 changed files with 2260 additions and 0 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -2,3 +2,5 @@
|
|||
*
|
||||
!/**/
|
||||
!*.*
|
||||
|
||||
.DS_Store
|
||||
|
|
|
|||
267
inc/html-to-markdown/CHANGELOG.md
Executable file
267
inc/html-to-markdown/CHANGELOG.md
Executable file
|
|
@ -0,0 +1,267 @@
|
|||
# Change Log
|
||||
All notable changes to this project will be documented in this file.
|
||||
Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
|
||||
|
||||
## [Unreleased][unreleased]
|
||||
|
||||
## [4.8.0] - 2018-09-18
|
||||
### Added
|
||||
- Added support for email auto-linking
|
||||
- Added a new interface (`HtmlConverterInterface`) for the main `HtmlConverter` class
|
||||
- Added additional test cases (#14)
|
||||
|
||||
### Changed
|
||||
- The `italic_style` option now defaults to `'*'` so that in-word emphasis is handled properly (#75)
|
||||
|
||||
### Fixed
|
||||
- Fixed several issues of `<code>` and `<pre>` tags not converting to blocks or inlines properly (#26, #70, #102, #140, #161, #162)
|
||||
- Fixed in-word emphasis using underscores as delimiter (#75)
|
||||
- Fixed character escaping inside of `<div>` elements
|
||||
- Fixed header edge cases
|
||||
|
||||
### Deprecated
|
||||
- The `bold_style` and `italic_style` options have been deprecated (#75)
|
||||
|
||||
## [4.7.0] - 2018-05-19
|
||||
### Added
|
||||
- Added `setOptions()` function for chainable calling (#149)
|
||||
- Added new `list_item_style_alternate` option for converting every-other list with a different character (#155)
|
||||
|
||||
### Fixed
|
||||
- Fixed insufficient newlines after code blocks (#144, #148)
|
||||
- Fixed trailing spaces not being preserved in link anchors (#157)
|
||||
- Fixed list-like lines not being escaped inside of lists items (#159)
|
||||
|
||||
## [4.6.2]
|
||||
### Fixed
|
||||
- Fixed issue with emphasized spaces (#146)
|
||||
|
||||
## [4.6.1]
|
||||
### Fixed
|
||||
- Fixed conversion of `<pre>` tags (#145)
|
||||
|
||||
## [4.6.0]
|
||||
### Added
|
||||
- Added support for ordered lists starting at numbers other than 1
|
||||
|
||||
### Fixed
|
||||
- Fixed overly-eager escaping of list-like text (#141)
|
||||
|
||||
## [4.5.0]
|
||||
### Added
|
||||
- Added configuration option for list item style (#135, #136)
|
||||
|
||||
## [4.4.1]
|
||||
|
||||
### Fixed
|
||||
- Fixed autolinking of invalid URLs (#129)
|
||||
|
||||
## [4.4.0]
|
||||
|
||||
### Added
|
||||
- Added `hard_break` configuration option (#112, #115)
|
||||
- The `HtmlConverter` can now be instantiated with an `Environment` (#118)
|
||||
|
||||
### Fixed
|
||||
- Fixed handling of paragraphs in list item elements (#47, #110)
|
||||
- Fixed phantom spaces when newlines follow `br` elements (#116, #117)
|
||||
- Fixed link converter not sanitizing inner spaces properly (#119, #120)
|
||||
|
||||
## [4.3.1]
|
||||
### Changed
|
||||
- Revised the sanitization implementation (#109)
|
||||
|
||||
### Fixed
|
||||
- Fixed tag-like content not being escaped (#67, #109)
|
||||
- Fixed thematic break-like content not being escaped (#65, #109)
|
||||
- Fixed codefence-like content not being escaped (#64, #109)
|
||||
|
||||
## [4.3.0]
|
||||
### Added
|
||||
- Added full support for PHP 7.0 and 7.1
|
||||
|
||||
### Changed
|
||||
- Changed `<pre>` and `<pre><code>` conversions to use backticks instead of indendation (#102)
|
||||
|
||||
### Fixed
|
||||
- Fixed issue where specified code language was not preserved (#70, #102)
|
||||
- Fixed issue where `<code>` tags nested in `<pre>` was not converted properly (#70, #102)
|
||||
- Fixed header-like content not being escaped (#76, #105)
|
||||
- Fixed blockquote-like content not being escaped (#77, #103)
|
||||
- Fixed ordered list-like content not being escaped (#73, #106)
|
||||
- Fixed unordered list-like content not being escaped (#71, #107)
|
||||
|
||||
## [4.2.2]
|
||||
### Fixed
|
||||
- Fixed sanitization bug which sometimes removes desired content (#63, #101)
|
||||
|
||||
## [4.2.1]
|
||||
### Fixed
|
||||
- Fixed path to autoload.php when used as a library (#98)
|
||||
- Fixed edge case for tags containing only whitespace (#99)
|
||||
|
||||
### Removed
|
||||
- Removed double HTML entity decoding, as this is not desireable (#60)
|
||||
|
||||
## [4.2.0]
|
||||
|
||||
### Added
|
||||
- Added the ability to invoke HtmlConverter objects as functions (#85)
|
||||
|
||||
### Fixed
|
||||
- Fixed improper handling of nested list items (#19 and #84)
|
||||
- Fixed preceeding or trailing spaces within emphasis tags (#83)
|
||||
|
||||
## [4.1.1]
|
||||
|
||||
### Fixed
|
||||
- Fixed conversion of empty paragraphs (#78)
|
||||
- Fixed `preg_replace` so it wouldn't break UTF-8 characters (#79)
|
||||
|
||||
## [4.1.0]
|
||||
|
||||
### Added
|
||||
- Added `bin/html-to-markdown` script
|
||||
|
||||
### Changed
|
||||
- Changed default italic character to `_` (#58)
|
||||
|
||||
## [4.0.1]
|
||||
|
||||
### Fixed
|
||||
- Added escaping to avoid * and _ in a text being rendered as emphasis (#48)
|
||||
|
||||
### Removed
|
||||
- Removed the demo (#51)
|
||||
- `.styleci.yml` and `CONTRIBUTING.md` are no longer included in distributions (#50)
|
||||
|
||||
## [4.0.0]
|
||||
|
||||
This release changes the visibility of several methods/properties. #42 and #43 brought to light that some visiblities were
|
||||
not ideally set, so this releases fixes that. Moving forwards this should reduce the chance of introducing BC-breaking changes.
|
||||
|
||||
### Added
|
||||
- Added new `HtmlConverter::getEnvironment()` method to expose the `Environment` (#42, #43)
|
||||
|
||||
### Changed
|
||||
- Changed `Environment::addConverter()` from `protected` to `public`, enabling custom converters to be added (#42, #43)
|
||||
- Changed `HtmlConverter::createDOMDocument()` from `protected` to `private`
|
||||
- Changed `Element::nextCached` from `protected` to `private`
|
||||
- Made the `Environment` class `final`
|
||||
|
||||
## [3.1.1]
|
||||
### Fixed
|
||||
- Empty HTML strings now result in empty Markdown documents (#40, #41)
|
||||
|
||||
## [3.1.0]
|
||||
### Added
|
||||
- Added new `equals` method to `Element` to check for equality
|
||||
|
||||
### Changes
|
||||
- Use Linux line endings consistently instead of plaform-specific line endings (#36)
|
||||
|
||||
### Fixed
|
||||
- Cleaned up code style
|
||||
|
||||
## [3.0.0]
|
||||
### Changed
|
||||
- Changed namespace to `League\HTMLToMarkdown`
|
||||
- Changed packagist name to `league/html-to-markdown`
|
||||
- Re-organized code into several separate classes
|
||||
- `<a>` tags with identical href and inner text are now rendered using angular bracket syntax (#31)
|
||||
- `<div>` elements are now treated as block-level elements (#33)
|
||||
|
||||
## [2.2.2]
|
||||
### Added
|
||||
- Added support for PHP 5.6 and HHVM
|
||||
- Enabled testing against PHP 7 nightlies
|
||||
- Added this CHANGELOG.md
|
||||
|
||||
### Fixed
|
||||
- Fixed whitespace preservation between inline elements (#9 and #10)
|
||||
|
||||
## [2.2.1]
|
||||
### Fixed
|
||||
- Preserve placeholder links (#22)
|
||||
|
||||
## [2.2.0]
|
||||
### Added
|
||||
- Added CircleCI config
|
||||
|
||||
### Changed
|
||||
- `<pre>` blocks are now treated as code elements
|
||||
|
||||
### Removed
|
||||
- Dropped support for PHP 5.2
|
||||
- Removed incorrect README comment regarding `#text` nodes (#17)
|
||||
|
||||
## [2.1.2]
|
||||
### Added
|
||||
- Added the ability to blacklist/remove specific node types (#11)
|
||||
|
||||
### Changed
|
||||
- Line breaks are now placed after divs instead of before them
|
||||
- Newlines inside of link texts are now removed
|
||||
- Updated the minimum PHPUnit version to 4.*
|
||||
|
||||
## [2.1.1]
|
||||
### Added
|
||||
- Added options to customize emphasis characters
|
||||
|
||||
## [2.1.0]
|
||||
### Added
|
||||
- Added option to strip HTML tags without Markdown equivalents
|
||||
- Added `convert()` method for converter reuse
|
||||
- Added ability to set options after instance construction
|
||||
- Documented the required PHP extensions (#4)
|
||||
|
||||
### Changed
|
||||
- ATX style now used for h1 and h2 tags inside blockquotes
|
||||
|
||||
### Fixed
|
||||
- Newlines inside blockquotes are now started with a bracket
|
||||
- Fixed some incorrect docblocks
|
||||
- `__toString()` now returns an empty string if input is empty
|
||||
- Convert head tag if body tag is empty (#7)
|
||||
- Preserve special characters inside tags without md equivalents (#6)
|
||||
|
||||
|
||||
## [2.0.1]
|
||||
### Fixed
|
||||
- Fixed first line indentation for multi-line code blocks
|
||||
- Fixed consecutive anchors get separating spaces stripped (#3)
|
||||
|
||||
## [2.0.0]
|
||||
### Added
|
||||
- Initial release
|
||||
|
||||
[unreleased]: https://github.com/thephpleague/html-to-markdown/compare/4.8.0...master
|
||||
[4.8.0]: https://github.com/thephpleague/html-to-markdown/compare/4.7.0...4.8.0
|
||||
[4.7.0]: https://github.com/thephpleague/html-to-markdown/compare/4.6.2...4.7.0
|
||||
[4.6.2]: https://github.com/thephpleague/html-to-markdown/compare/4.6.1...4.6.2
|
||||
[4.6.1]: https://github.com/thephpleague/html-to-markdown/compare/4.6.0...4.6.1
|
||||
[4.6.0]: https://github.com/thephpleague/html-to-markdown/compare/4.5.0...4.6.0
|
||||
[4.5.0]: https://github.com/thephpleague/html-to-markdown/compare/4.4.1...4.5.0
|
||||
[4.4.1]: https://github.com/thephpleague/html-to-markdown/compare/4.4.0...4.4.1
|
||||
[4.4.0]: https://github.com/thephpleague/html-to-markdown/compare/4.3.1...4.4.0
|
||||
[4.3.1]: https://github.com/thephpleague/html-to-markdown/compare/4.3.0...4.3.1
|
||||
[4.3.0]: https://github.com/thephpleague/html-to-markdown/compare/4.2.2...4.3.0
|
||||
[4.2.2]: https://github.com/thephpleague/html-to-markdown/compare/4.2.1...4.2.2
|
||||
[4.2.1]: https://github.com/thephpleague/html-to-markdown/compare/4.2.0...4.2.1
|
||||
[4.2.0]: https://github.com/thephpleague/html-to-markdown/compare/4.1.1...4.2.0
|
||||
[4.1.1]: https://github.com/thephpleague/html-to-markdown/compare/4.1.0...4.1.1
|
||||
[4.1.0]: https://github.com/thephpleague/html-to-markdown/compare/4.0.1...4.1.0
|
||||
[4.0.1]: https://github.com/thephpleague/html-to-markdown/compare/4.0.0...4.0.1
|
||||
[4.0.0]: https://github.com/thephpleague/html-to-markdown/compare/3.1.1...4.0.0
|
||||
[3.1.1]: https://github.com/thephpleague/html-to-markdown/compare/3.1.0...3.1.1
|
||||
[3.1.0]: https://github.com/thephpleague/html-to-markdown/compare/3.0.0...3.1.0
|
||||
[3.0.0]: https://github.com/thephpleague/html-to-markdown/compare/2.2.2...3.0.0
|
||||
[2.2.2]: https://github.com/thephpleague/html-to-markdown/compare/2.2.1...2.2.2
|
||||
[2.2.1]: https://github.com/thephpleague/html-to-markdown/compare/2.2.0...2.2.1
|
||||
[2.2.0]: https://github.com/thephpleague/html-to-markdown/compare/2.1.2...2.2.0
|
||||
[2.1.2]: https://github.com/thephpleague/html-to-markdown/compare/2.1.1...2.1.2
|
||||
[2.1.1]: https://github.com/thephpleague/html-to-markdown/compare/2.1.0...2.1.1
|
||||
[2.1.0]: https://github.com/thephpleague/html-to-markdown/compare/2.0.1...2.1.0
|
||||
[2.0.1]: https://github.com/thephpleague/html-to-markdown/compare/2.0.0...2.0.1
|
||||
[2.0.0]: https://github.com/thephpleague/html-to-markdown/compare/775f91e...2.0.0
|
||||
|
||||
22
inc/html-to-markdown/CONDUCT.md
Executable file
22
inc/html-to-markdown/CONDUCT.md
Executable file
|
|
@ -0,0 +1,22 @@
|
|||
# Contributor Code of Conduct
|
||||
|
||||
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
|
||||
|
||||
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery
|
||||
* Personal attacks
|
||||
* Trolling or insulting/derogatory comments
|
||||
* Public or private harassment
|
||||
* Publishing other's private information, such as physical or electronic addresses, without explicit permission
|
||||
* Other unethical or unprofessional conduct.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
|
||||
|
||||
This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
|
||||
196
inc/html-to-markdown/README.md
Executable file
196
inc/html-to-markdown/README.md
Executable file
|
|
@ -0,0 +1,196 @@
|
|||
HTML To Markdown for PHP
|
||||
========================
|
||||
|
||||
[](https://gitter.im/thephpleague/html-to-markdown?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
[](https://packagist.org/packages/league/html-to-markdown)
|
||||
[](LICENSE)
|
||||
[](https://travis-ci.org/thephpleague/html-to-markdown)
|
||||
[](https://scrutinizer-ci.com/g/thephpleague/html-to-markdown/code-structure)
|
||||
[](https://scrutinizer-ci.com/g/thephpleague/html-to-markdown)
|
||||
[](https://packagist.org/packages/league/html-to-markdown)
|
||||
|
||||
Library which converts HTML to [Markdown](http://daringfireball.net/projects/markdown/) for your sanity and convenience.
|
||||
|
||||
|
||||
**Requires**: PHP 5.3+ or PHP 7.0+
|
||||
|
||||
**Lead Developer**: [@colinodell](http://twitter.com/colinodell)
|
||||
|
||||
**Original Author**: [@nickcernis](http://twitter.com/nickcernis)
|
||||
|
||||
|
||||
### Why convert HTML to Markdown?
|
||||
|
||||
*"What alchemy is this?"* you mutter. *"I can see why you'd convert [Markdown to HTML](https://github.com/thephpleague/commonmark),"* you continue, already labouring the question somewhat, *"but why go the other way?"*
|
||||
|
||||
Typically you would convert HTML to Markdown if:
|
||||
|
||||
1. You have an existing HTML document that needs to be edited by people with good taste.
|
||||
2. You want to store new content in HTML format but edit it as Markdown.
|
||||
3. You want to convert HTML email to plain text email.
|
||||
4. You know a guy who's been converting HTML to Markdown for years, and now he can speak Elvish. You'd quite like to be able to speak Elvish.
|
||||
5. You just really like Markdown.
|
||||
|
||||
### How to use it
|
||||
|
||||
Require the library by issuing this command:
|
||||
|
||||
```bash
|
||||
composer require league/html-to-markdown
|
||||
```
|
||||
|
||||
Add `require 'vendor/autoload.php';` to the top of your script.
|
||||
|
||||
Next, create a new HtmlConverter instance, passing in your valid HTML code to its `convert()` function:
|
||||
|
||||
```php
|
||||
use League\HTMLToMarkdown\HtmlConverter;
|
||||
|
||||
$converter = new HtmlConverter();
|
||||
|
||||
$html = "<h3>Quick, to the Batpoles!</h3>";
|
||||
$markdown = $converter->convert($html);
|
||||
```
|
||||
|
||||
The `$markdown` variable now contains the Markdown version of your HTML as a string:
|
||||
|
||||
```php
|
||||
echo $markdown; // ==> ### Quick, to the Batpoles!
|
||||
```
|
||||
|
||||
The included `demo` directory contains an HTML->Markdown conversion form to try out.
|
||||
|
||||
### Conversion options
|
||||
|
||||
By default, HTML To Markdown preserves HTML tags without Markdown equivalents, like `<span>` and `<div>`.
|
||||
|
||||
To strip HTML tags that don't have a Markdown equivalent while preserving the content inside them, set `strip_tags` to true, like this:
|
||||
|
||||
```php
|
||||
$converter = new HtmlConverter(array('strip_tags' => true));
|
||||
|
||||
$html = '<span>Turnips!</span>';
|
||||
$markdown = $converter->convert($html); // $markdown now contains "Turnips!"
|
||||
```
|
||||
|
||||
Or more explicitly, like this:
|
||||
|
||||
```php
|
||||
$converter = new HtmlConverter();
|
||||
$converter->getConfig()->setOption('strip_tags', true);
|
||||
|
||||
$html = '<span>Turnips!</span>';
|
||||
$markdown = $converter->convert($html); // $markdown now contains "Turnips!"
|
||||
```
|
||||
|
||||
Note that only the tags themselves are stripped, not the content they hold.
|
||||
|
||||
To strip tags and their content, pass a space-separated list of tags in `remove_nodes`, like this:
|
||||
|
||||
```php
|
||||
$converter = new HtmlConverter(array('remove_nodes' => 'span div'));
|
||||
|
||||
$html = '<span>Turnips!</span><div>Monkeys!</div>';
|
||||
$markdown = $converter->convert($html); // $markdown now contains ""
|
||||
```
|
||||
|
||||
### Style options
|
||||
|
||||
By default bold tags are converted using the asterisk syntax, and italic tags are converted using the underlined syntax. Change these by using the `bold_style` and `italic_style` options.
|
||||
|
||||
```php
|
||||
$converter = new HtmlConverter();
|
||||
$converter->getConfig()->setOption('italic_style', '*');
|
||||
$converter->getConfig()->setOption('bold_style', '__');
|
||||
|
||||
$html = '<em>Italic</em> and a <strong>bold</strong>';
|
||||
$markdown = $converter->convert($html); // $markdown now contains "*Italic* and a __bold__"
|
||||
```
|
||||
|
||||
### Line break options
|
||||
|
||||
By default, `br` tags are converted to two spaces followed by a newline character as per [traditional Markdown](https://daringfireball.net/projects/markdown/syntax#p). Set `hard_break` to `true` to omit the two spaces, as per GitHub Flavored Markdown (GFM).
|
||||
|
||||
```php
|
||||
$converter = new HtmlConverter();
|
||||
$html = '<p>test<br>line break</p>';
|
||||
|
||||
$converter->getConfig()->setOption('hard_break', true);
|
||||
$markdown = $converter->convert($html); // $markdown now contains "test\nline break"
|
||||
|
||||
$converter->getConfig()->setOption('hard_break', false); // default
|
||||
$markdown = $converter->convert($html); // $markdown now contains "test \nline break"
|
||||
```
|
||||
|
||||
### Passing custom Environment object
|
||||
|
||||
You can pass current `Environment` object to customize i.e. which converters should be used.
|
||||
|
||||
```php
|
||||
$environment = new Environment(array(
|
||||
// your configuration here
|
||||
));
|
||||
$environment->addConverter(new HeaderConverter()); // optionally - add converter manually
|
||||
|
||||
$converter = new HtmlConverter($environment);
|
||||
|
||||
$html = '<h3>Header</h3>
|
||||
<img src="" />
|
||||
';
|
||||
$markdown = $converter->convert($html); // $markdown now contains "### Header" and "<img src="" />"
|
||||
```
|
||||
|
||||
### Limitations
|
||||
|
||||
- Markdown Extra, MultiMarkdown and other variants aren't supported – just Markdown.
|
||||
|
||||
### Known issues
|
||||
|
||||
- Nested lists and lists containing multiple paragraphs aren't converted correctly.
|
||||
- Lists inside blockquotes aren't converted correctly.
|
||||
- Any reported [open issues here](https://github.com/thephpleague/html-to-markdown/issues?state=open).
|
||||
|
||||
[Report your issue or request a feature here.](https://github.com/thephpleague/html-to-markdown/issues/new) Issues with patches or failing tests are especially welcome.
|
||||
|
||||
### Style notes
|
||||
|
||||
- Setext (underlined) headers are the default for H1 and H2. If you prefer the ATX style for H1 and H2 (# Header 1 and ## Header 2), set `header_style` to 'atx' in the options array when you instantiate the object:
|
||||
|
||||
`$converter = new HtmlConverter(array('header_style'=>'atx'));`
|
||||
|
||||
Headers of H3 priority and lower always use atx style.
|
||||
|
||||
- Links and images are referenced inline. Footnote references (where image src and anchor href attributes are listed in the footnotes) are not used.
|
||||
- Blockquotes aren't line wrapped – it makes the converted Markdown easier to edit.
|
||||
|
||||
### Dependencies
|
||||
|
||||
HTML To Markdown requires PHP's [xml](http://www.php.net/manual/en/xml.installation.php), [lib-xml](http://www.php.net/manual/en/libxml.installation.php), and [dom](http://www.php.net/manual/en/dom.installation.php) extensions, all of which are enabled by default on most distributions.
|
||||
|
||||
Errors such as "Fatal error: Class 'DOMDocument' not found" on distributions such as CentOS that disable PHP's xml extension can be resolved by installing php-xml.
|
||||
|
||||
### Contributors
|
||||
|
||||
Many thanks to all [contributors](https://github.com/thephpleague/html-to-markdown/graphs/contributors) so far. Further improvements and feature suggestions are very welcome.
|
||||
|
||||
### How it works
|
||||
|
||||
HTML To Markdown creates a DOMDocument from the supplied HTML, walks through the tree, and converts each node to a text node containing the equivalent markdown, starting from the most deeply nested node and working inwards towards the root node.
|
||||
|
||||
### To-do
|
||||
|
||||
- Support for nested lists and lists inside blockquotes.
|
||||
- Offer an option to preserve tags as HTML if they contain attributes that can't be represented with Markdown (e.g. `style`).
|
||||
|
||||
### Trying to convert Markdown to HTML?
|
||||
|
||||
Use one of these great libraries:
|
||||
|
||||
- [league/commonmark](https://github.com/thephpleague/commonmark) (recommended)
|
||||
- [cebe/markdown](https://github.com/cebe/markdown)
|
||||
- [PHP Markdown](https://michelf.ca/projects/php-markdown/)
|
||||
- [Parsedown](https://github.com/erusev/parsedown)
|
||||
|
||||
No guarantees about the Elvish, though.
|
||||
|
||||
48
inc/html-to-markdown/composer.json
Executable file
48
inc/html-to-markdown/composer.json
Executable file
|
|
@ -0,0 +1,48 @@
|
|||
{
|
||||
"name": "league/html-to-markdown",
|
||||
"type": "library",
|
||||
"description": "An HTML-to-markdown conversion helper for PHP",
|
||||
"keywords": ["markdown", "html"],
|
||||
"homepage": "https://github.com/thephpleague/html-to-markdown",
|
||||
"license": "MIT",
|
||||
"authors": [
|
||||
{
|
||||
"name": "Colin O'Dell",
|
||||
"email": "colinodell@gmail.com",
|
||||
"homepage": "https://www.colinodell.com",
|
||||
"role": "Lead Developer"
|
||||
},
|
||||
{
|
||||
"name": "Nick Cernis",
|
||||
"email": "nick@cern.is",
|
||||
"homepage": "http://modernnerd.net",
|
||||
"role": "Original Author"
|
||||
}
|
||||
],
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"League\\HTMLToMarkdown\\": "src/"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"League\\HTMLToMarkdown\\Test\\": "tests"
|
||||
}
|
||||
},
|
||||
"require": {
|
||||
"php": ">=5.3.3",
|
||||
"ext-dom": "*",
|
||||
"ext-xml": "*"
|
||||
},
|
||||
"require-dev": {
|
||||
"mikehaertl/php-shellcommand": "~1.1.0",
|
||||
"phpunit/phpunit": "4.*",
|
||||
"scrutinizer/ocular": "~1.1"
|
||||
},
|
||||
"bin": ["bin/html-to-markdown"],
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "4.9-dev"
|
||||
}
|
||||
}
|
||||
}
|
||||
76
inc/html-to-markdown/src/Configuration.php
Executable file
76
inc/html-to-markdown/src/Configuration.php
Executable file
|
|
@ -0,0 +1,76 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown;
|
||||
|
||||
class Configuration
|
||||
{
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* @param array $config
|
||||
*/
|
||||
public function __construct(array $config = array())
|
||||
{
|
||||
$this->config = $config;
|
||||
|
||||
$this->checkForDeprecatedOptions($config);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $config
|
||||
*/
|
||||
public function merge(array $config = array())
|
||||
{
|
||||
$this->checkForDeprecatedOptions($config);
|
||||
$this->config = array_replace_recursive($this->config, $config);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $config
|
||||
*/
|
||||
public function replace(array $config = array())
|
||||
{
|
||||
$this->checkForDeprecatedOptions($config);
|
||||
$this->config = $config;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $key
|
||||
* @param mixed $value
|
||||
*/
|
||||
public function setOption($key, $value)
|
||||
{
|
||||
$this->checkForDeprecatedOptions(array($key => $value));
|
||||
$this->config[$key] = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|null $key
|
||||
* @param mixed|null $default
|
||||
*
|
||||
* @return mixed|null
|
||||
*/
|
||||
public function getOption($key = null, $default = null)
|
||||
{
|
||||
if ($key === null) {
|
||||
return $this->config;
|
||||
}
|
||||
|
||||
if (!isset($this->config[$key])) {
|
||||
return $default;
|
||||
}
|
||||
|
||||
return $this->config[$key];
|
||||
}
|
||||
|
||||
private function checkForDeprecatedOptions(array $config)
|
||||
{
|
||||
foreach ($config as $key => $value) {
|
||||
if ($key === 'bold_style' && $value !== '**') {
|
||||
@trigger_error('Customizing the bold_style option is deprecated and may be removed in the next major version', E_USER_DEPRECATED);
|
||||
} elseif ($key === 'italic_style' && $value !== '*') {
|
||||
@trigger_error('Customizing the italic_style option is deprecated and may be removed in the next major version', E_USER_DEPRECATED);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
11
inc/html-to-markdown/src/ConfigurationAwareInterface.php
Executable file
11
inc/html-to-markdown/src/ConfigurationAwareInterface.php
Executable file
|
|
@ -0,0 +1,11 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown;
|
||||
|
||||
interface ConfigurationAwareInterface
|
||||
{
|
||||
/**
|
||||
* @param Configuration $config
|
||||
*/
|
||||
public function setConfig(Configuration $config);
|
||||
}
|
||||
44
inc/html-to-markdown/src/Converter/BlockquoteConverter.php
Executable file
44
inc/html-to-markdown/src/Converter/BlockquoteConverter.php
Executable file
|
|
@ -0,0 +1,44 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class BlockquoteConverter implements ConverterInterface
|
||||
{
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
// Contents should have already been converted to Markdown by this point,
|
||||
// so we just need to add '>' symbols to each line.
|
||||
|
||||
$markdown = '';
|
||||
|
||||
$quote_content = trim($element->getValue());
|
||||
|
||||
$lines = preg_split('/\r\n|\r|\n/', $quote_content);
|
||||
|
||||
$total_lines = count($lines);
|
||||
|
||||
foreach ($lines as $i => $line) {
|
||||
$markdown .= '> ' . $line . "\n";
|
||||
if ($i + 1 === $total_lines) {
|
||||
$markdown .= "\n";
|
||||
}
|
||||
}
|
||||
|
||||
return $markdown;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('blockquote');
|
||||
}
|
||||
}
|
||||
79
inc/html-to-markdown/src/Converter/CodeConverter.php
Executable file
79
inc/html-to-markdown/src/Converter/CodeConverter.php
Executable file
|
|
@ -0,0 +1,79 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class CodeConverter implements ConverterInterface
|
||||
{
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
$language = '';
|
||||
|
||||
// Checking for language class on the code block
|
||||
$classes = $element->getAttribute('class');
|
||||
|
||||
if ($classes) {
|
||||
// Since tags can have more than one class, we need to find the one that starts with 'language-'
|
||||
$classes = explode(' ', $classes);
|
||||
foreach ($classes as $class) {
|
||||
if (strpos($class, 'language-') !== false) {
|
||||
// Found one, save it as the selected language and stop looping over the classes.
|
||||
$language = str_replace('language-', '', $class);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$markdown = '';
|
||||
$code = html_entity_decode($element->getChildrenAsString());
|
||||
|
||||
// In order to remove the code tags we need to search for them and, in the case of the opening tag
|
||||
// use a regular expression to find the tag and the other attributes it might have
|
||||
$code = preg_replace('/<code\b[^>]*>/', '', $code);
|
||||
$code = str_replace('</code>', '', $code);
|
||||
|
||||
// Checking if it's a code block or span
|
||||
if ($this->shouldBeBlock($element, $code)) {
|
||||
// Code block detected, newlines will be added in parent
|
||||
$markdown .= '```' . $language . "\n" . $code . "\n" . '```';
|
||||
} else {
|
||||
// One line of code, wrapping it on one backtick, removing new lines
|
||||
$markdown .= '`' . preg_replace('/\r\n|\r|\n/', '', $code) . '`';
|
||||
}
|
||||
|
||||
return $markdown;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('code');
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
* @param string $code
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private function shouldBeBlock(ElementInterface $element, $code)
|
||||
{
|
||||
if ($element->getParent()->getTagName() == 'pre') {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (preg_match('/[^\s]` `/', $code)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
26
inc/html-to-markdown/src/Converter/CommentConverter.php
Executable file
26
inc/html-to-markdown/src/Converter/CommentConverter.php
Executable file
|
|
@ -0,0 +1,26 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class CommentConverter implements ConverterInterface
|
||||
{
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('#comment');
|
||||
}
|
||||
}
|
||||
20
inc/html-to-markdown/src/Converter/ConverterInterface.php
Executable file
20
inc/html-to-markdown/src/Converter/ConverterInterface.php
Executable file
|
|
@ -0,0 +1,20 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
interface ConverterInterface
|
||||
{
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element);
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags();
|
||||
}
|
||||
50
inc/html-to-markdown/src/Converter/DefaultConverter.php
Executable file
50
inc/html-to-markdown/src/Converter/DefaultConverter.php
Executable file
|
|
@ -0,0 +1,50 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\Configuration;
|
||||
use League\HTMLToMarkdown\ConfigurationAwareInterface;
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class DefaultConverter implements ConverterInterface, ConfigurationAwareInterface
|
||||
{
|
||||
const DEFAULT_CONVERTER = '_default';
|
||||
|
||||
/**
|
||||
* @var Configuration
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* @param Configuration $config
|
||||
*/
|
||||
public function setConfig(Configuration $config)
|
||||
{
|
||||
$this->config = $config;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
// If strip_tags is false (the default), preserve tags that don't have Markdown equivalents,
|
||||
// such as <span> nodes on their own. C14N() canonicalizes the node to a string.
|
||||
// See: http://www.php.net/manual/en/domnode.c14n.php
|
||||
if ($this->config->getOption('strip_tags', false)) {
|
||||
return $element->getValue();
|
||||
}
|
||||
|
||||
return html_entity_decode($element->getChildrenAsString());
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array(self::DEFAULT_CONVERTER);
|
||||
}
|
||||
}
|
||||
45
inc/html-to-markdown/src/Converter/DivConverter.php
Executable file
45
inc/html-to-markdown/src/Converter/DivConverter.php
Executable file
|
|
@ -0,0 +1,45 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\Configuration;
|
||||
use League\HTMLToMarkdown\ConfigurationAwareInterface;
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class DivConverter implements ConverterInterface, ConfigurationAwareInterface
|
||||
{
|
||||
/**
|
||||
* @var Configuration
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* @param Configuration $config
|
||||
*/
|
||||
public function setConfig(Configuration $config)
|
||||
{
|
||||
$this->config = $config;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
if ($this->config->getOption('strip_tags', false)) {
|
||||
return $element->getValue() . "\n\n";
|
||||
}
|
||||
|
||||
return html_entity_decode($element->getChildrenAsString());
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('div');
|
||||
}
|
||||
}
|
||||
57
inc/html-to-markdown/src/Converter/EmphasisConverter.php
Executable file
57
inc/html-to-markdown/src/Converter/EmphasisConverter.php
Executable file
|
|
@ -0,0 +1,57 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\Configuration;
|
||||
use League\HTMLToMarkdown\ConfigurationAwareInterface;
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class EmphasisConverter implements ConverterInterface, ConfigurationAwareInterface
|
||||
{
|
||||
/**
|
||||
* @var Configuration
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* @param Configuration $config
|
||||
*/
|
||||
public function setConfig(Configuration $config)
|
||||
{
|
||||
$this->config = $config;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
$tag = $element->getTagName();
|
||||
$value = $element->getValue();
|
||||
|
||||
if (!trim($value)) {
|
||||
return $value;
|
||||
}
|
||||
|
||||
if ($tag === 'i' || $tag === 'em') {
|
||||
$style = $this->config->getOption('italic_style');
|
||||
} else {
|
||||
$style = $this->config->getOption('bold_style');
|
||||
}
|
||||
|
||||
$prefix = ltrim($value) !== $value ? ' ' : '';
|
||||
$suffix = rtrim($value) !== $value ? ' ' : '';
|
||||
|
||||
return $prefix . $style . trim($value) . $style . $suffix;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('em', 'i', 'strong', 'b');
|
||||
}
|
||||
}
|
||||
53
inc/html-to-markdown/src/Converter/HardBreakConverter.php
Executable file
53
inc/html-to-markdown/src/Converter/HardBreakConverter.php
Executable file
|
|
@ -0,0 +1,53 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\Configuration;
|
||||
use League\HTMLToMarkdown\ConfigurationAwareInterface;
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class HardBreakConverter implements ConverterInterface, ConfigurationAwareInterface
|
||||
{
|
||||
/**
|
||||
* @var Configuration
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* @param Configuration $config
|
||||
*/
|
||||
public function setConfig(Configuration $config)
|
||||
{
|
||||
$this->config = $config;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
$return = $this->config->getOption('hard_break') ? "\n" : " \n";
|
||||
|
||||
$next = $element->getNext();
|
||||
if ($next) {
|
||||
$next_value = $next->getValue();
|
||||
if ($next_value) {
|
||||
if (in_array(substr($next_value, 0, 2), array('- ', '* ', '+ '))) {
|
||||
$return .= '\\';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('br');
|
||||
}
|
||||
}
|
||||
82
inc/html-to-markdown/src/Converter/HeaderConverter.php
Executable file
82
inc/html-to-markdown/src/Converter/HeaderConverter.php
Executable file
|
|
@ -0,0 +1,82 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\Configuration;
|
||||
use League\HTMLToMarkdown\ConfigurationAwareInterface;
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class HeaderConverter implements ConverterInterface, ConfigurationAwareInterface
|
||||
{
|
||||
const STYLE_ATX = 'atx';
|
||||
const STYLE_SETEXT = 'setext';
|
||||
|
||||
/**
|
||||
* @var Configuration
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* @param Configuration $config
|
||||
*/
|
||||
public function setConfig(Configuration $config)
|
||||
{
|
||||
$this->config = $config;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
$level = (int) substr($element->getTagName(), 1, 1);
|
||||
$style = $this->config->getOption('header_style', self::STYLE_SETEXT);
|
||||
|
||||
if (strlen($element->getValue()) === 0) {
|
||||
return '';
|
||||
}
|
||||
|
||||
if (($level === 1 || $level === 2) && !$element->isDescendantOf('blockquote') && $style === self::STYLE_SETEXT) {
|
||||
return $this->createSetextHeader($level, $element->getValue());
|
||||
}
|
||||
|
||||
return $this->createAtxHeader($level, $element->getValue());
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('h1', 'h2', 'h3', 'h4', 'h5', 'h6');
|
||||
}
|
||||
|
||||
/**
|
||||
* @param int $level
|
||||
* @param string $content
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function createSetextHeader($level, $content)
|
||||
{
|
||||
$length = function_exists('mb_strlen') ? mb_strlen($content, 'utf-8') : strlen($content);
|
||||
$underline = ($level === 1) ? '=' : '-';
|
||||
|
||||
return $content . "\n" . str_repeat($underline, $length) . "\n\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* @param int $level
|
||||
* @param string $content
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function createAtxHeader($level, $content)
|
||||
{
|
||||
$prefix = str_repeat('#', $level) . ' ';
|
||||
|
||||
return $prefix . $content . "\n\n";
|
||||
}
|
||||
}
|
||||
26
inc/html-to-markdown/src/Converter/HorizontalRuleConverter.php
Executable file
26
inc/html-to-markdown/src/Converter/HorizontalRuleConverter.php
Executable file
|
|
@ -0,0 +1,26 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class HorizontalRuleConverter implements ConverterInterface
|
||||
{
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
return "- - - - - -\n\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('hr');
|
||||
}
|
||||
}
|
||||
35
inc/html-to-markdown/src/Converter/ImageConverter.php
Executable file
35
inc/html-to-markdown/src/Converter/ImageConverter.php
Executable file
|
|
@ -0,0 +1,35 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class ImageConverter implements ConverterInterface
|
||||
{
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
$src = $element->getAttribute('src');
|
||||
$alt = $element->getAttribute('alt');
|
||||
$title = $element->getAttribute('title');
|
||||
|
||||
if ($title !== '') {
|
||||
// No newlines added. <img> should be in a block-level element.
|
||||
return '';
|
||||
}
|
||||
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('img');
|
||||
}
|
||||
}
|
||||
65
inc/html-to-markdown/src/Converter/LinkConverter.php
Executable file
65
inc/html-to-markdown/src/Converter/LinkConverter.php
Executable file
|
|
@ -0,0 +1,65 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class LinkConverter implements ConverterInterface
|
||||
{
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
$href = $element->getAttribute('href');
|
||||
$title = $element->getAttribute('title');
|
||||
$text = trim($element->getValue(), "\t\n\r\0\x0B");
|
||||
|
||||
if ($title !== '') {
|
||||
$markdown = '[' . $text . '](' . $href . ' "' . $title . '")';
|
||||
} elseif ($href === $text && $this->isValidAutolink($href)) {
|
||||
$markdown = '<' . $href . '>';
|
||||
} elseif ($href === 'mailto:' . $text && $this->isValidEmail($text)) {
|
||||
$markdown = '<' . $text . '>';
|
||||
} else {
|
||||
$markdown = '[' . $text . '](' . $href . ')';
|
||||
}
|
||||
|
||||
if (!$href) {
|
||||
$markdown = html_entity_decode($element->getChildrenAsString());
|
||||
}
|
||||
|
||||
return $markdown;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('a');
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $href
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private function isValidAutolink($href)
|
||||
{
|
||||
return preg_match('/^[A-Za-z][A-Za-z0-9.+-]{1,31}:[^<>\x00-\x20]*/i', $href) === 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $email
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private function isValidEmail($email)
|
||||
{
|
||||
// Email validation is messy business, but this should cover most cases
|
||||
return filter_var($email, FILTER_VALIDATE_EMAIL);
|
||||
}
|
||||
}
|
||||
26
inc/html-to-markdown/src/Converter/ListBlockConverter.php
Executable file
26
inc/html-to-markdown/src/Converter/ListBlockConverter.php
Executable file
|
|
@ -0,0 +1,26 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class ListBlockConverter implements ConverterInterface
|
||||
{
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
return $element->getValue() . "\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('ol', 'ul');
|
||||
}
|
||||
}
|
||||
81
inc/html-to-markdown/src/Converter/ListItemConverter.php
Executable file
81
inc/html-to-markdown/src/Converter/ListItemConverter.php
Executable file
|
|
@ -0,0 +1,81 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\Configuration;
|
||||
use League\HTMLToMarkdown\ConfigurationAwareInterface;
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class ListItemConverter implements ConverterInterface, ConfigurationAwareInterface
|
||||
{
|
||||
/**
|
||||
* @var Configuration
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected $listItemStyle;
|
||||
|
||||
/**
|
||||
* @param Configuration $config
|
||||
*/
|
||||
public function setConfig(Configuration $config)
|
||||
{
|
||||
$this->config = $config;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
// If parent is an ol, use numbers, otherwise, use dashes
|
||||
$list_type = $element->getParent()->getTagName();
|
||||
|
||||
// Add spaces to start for nested list items
|
||||
$level = $element->getListItemLevel($element);
|
||||
|
||||
$prefixForParagraph = str_repeat(' ', $level + 1);
|
||||
$value = trim(implode("\n" . $prefixForParagraph, explode("\n", trim($element->getValue()))));
|
||||
|
||||
// If list item is the first in a nested list, add a newline before it
|
||||
$prefix = '';
|
||||
if ($level > 0 && $element->getSiblingPosition() === 1) {
|
||||
$prefix = "\n";
|
||||
}
|
||||
|
||||
if ($list_type === 'ul') {
|
||||
$list_item_style = $this->config->getOption('list_item_style', '-');
|
||||
$list_item_style_alternate = $this->config->getOption('list_item_style_alternate');
|
||||
if (!isset($this->listItemStyle)) {
|
||||
$this->listItemStyle = $list_item_style_alternate ? $list_item_style_alternate : $list_item_style;
|
||||
}
|
||||
|
||||
if ($list_item_style_alternate && $level == 0 && $element->getSiblingPosition() === 1) {
|
||||
$this->listItemStyle = $this->listItemStyle == $list_item_style ? $list_item_style_alternate : $list_item_style;
|
||||
}
|
||||
|
||||
return $prefix . $this->listItemStyle . ' ' . $value . "\n";
|
||||
}
|
||||
|
||||
if ($list_type === 'ol' && $start = $element->getParent()->getAttribute('start')) {
|
||||
$number = $start + $element->getSiblingPosition() - 1;
|
||||
} else {
|
||||
$number = $element->getSiblingPosition();
|
||||
}
|
||||
|
||||
return $prefix . $number . '. ' . $value . "\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('li');
|
||||
}
|
||||
}
|
||||
125
inc/html-to-markdown/src/Converter/ParagraphConverter.php
Executable file
125
inc/html-to-markdown/src/Converter/ParagraphConverter.php
Executable file
|
|
@ -0,0 +1,125 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class ParagraphConverter implements ConverterInterface
|
||||
{
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
$value = $element->getValue();
|
||||
|
||||
$markdown = '';
|
||||
|
||||
$lines = preg_split('/\r\n|\r|\n/', $value);
|
||||
foreach ($lines as $line) {
|
||||
/*
|
||||
* Some special characters need to be escaped based on the position that they appear
|
||||
* The following function will deal with those special cases.
|
||||
*/
|
||||
$markdown .= $this->escapeSpecialCharacters($line);
|
||||
$markdown .= "\n";
|
||||
}
|
||||
|
||||
return trim($markdown) !== '' ? rtrim($markdown) . "\n\n" : '';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('p');
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $line
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function escapeSpecialCharacters($line)
|
||||
{
|
||||
$line = $this->escapeFirstCharacters($line);
|
||||
$line = $this->escapeOtherCharacters($line);
|
||||
$line = $this->escapeOtherCharactersRegex($line);
|
||||
|
||||
return $line;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $line
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function escapeFirstCharacters($line)
|
||||
{
|
||||
$escapable = array(
|
||||
'>',
|
||||
'- ',
|
||||
'+ ',
|
||||
'--',
|
||||
'~~~',
|
||||
'---',
|
||||
'- - -'
|
||||
);
|
||||
|
||||
foreach ($escapable as $i) {
|
||||
if (strpos(ltrim($line), $i) === 0) {
|
||||
// Found a character that must be escaped, adding a backslash before
|
||||
return '\\' . ltrim($line);
|
||||
}
|
||||
}
|
||||
|
||||
return $line;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $line
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function escapeOtherCharacters($line)
|
||||
{
|
||||
$escapable = array(
|
||||
'<!--'
|
||||
);
|
||||
|
||||
foreach ($escapable as $i) {
|
||||
if (strpos($line, $i) !== false) {
|
||||
// Found an escapable character, escaping it
|
||||
$line = substr_replace($line, '\\', strpos($line, $i), 0);
|
||||
}
|
||||
}
|
||||
|
||||
return $line;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $line
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function escapeOtherCharactersRegex($line)
|
||||
{
|
||||
$regExs = array(
|
||||
// Match numbers ending on ')' or '.' that are at the beginning of the line.
|
||||
// They will be escaped if immediately followed by a space or newline.
|
||||
'/^[0-9]+(?=(\)|\.)( |$))/'
|
||||
);
|
||||
|
||||
foreach ($regExs as $i) {
|
||||
if (preg_match($i, $line, $match)) {
|
||||
// Matched an escapable character, adding a backslash on the string before the offending character
|
||||
$line = substr_replace($line, '\\', strlen($match[0]), 0);
|
||||
}
|
||||
}
|
||||
|
||||
return $line;
|
||||
}
|
||||
}
|
||||
58
inc/html-to-markdown/src/Converter/PreformattedConverter.php
Executable file
58
inc/html-to-markdown/src/Converter/PreformattedConverter.php
Executable file
|
|
@ -0,0 +1,58 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class PreformattedConverter implements ConverterInterface
|
||||
{
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
$pre_content = html_entity_decode($element->getChildrenAsString());
|
||||
$pre_content = str_replace(array('<pre>', '</pre>'), '', $pre_content);
|
||||
|
||||
/*
|
||||
* Checking for the code tag.
|
||||
* Usually pre tags are used along with code tags. This conditional will check for already converted code tags,
|
||||
* which use backticks, and if those backticks are at the beginning and at the end of the string it means
|
||||
* there's no more information to convert.
|
||||
*/
|
||||
|
||||
$firstBacktick = strpos(trim($pre_content), '`');
|
||||
$lastBacktick = strrpos(trim($pre_content), '`');
|
||||
if ($firstBacktick === 0 && $lastBacktick === strlen(trim($pre_content)) - 1) {
|
||||
return $pre_content . "\n\n";
|
||||
}
|
||||
|
||||
// If the execution reaches this point it means it's just a pre tag, with no code tag nested
|
||||
|
||||
// Empty lines are a special case
|
||||
if ($pre_content === '') {
|
||||
return "```\n```\n\n";
|
||||
}
|
||||
|
||||
// Normalizing new lines
|
||||
$pre_content = preg_replace('/\r\n|\r|\n/', "\n", $pre_content);
|
||||
|
||||
// Ensure there's a newline at the end
|
||||
if (strrpos($pre_content, "\n") !== strlen($pre_content) - strlen("\n")) {
|
||||
$pre_content .= "\n";
|
||||
}
|
||||
|
||||
// Use three backticks
|
||||
return "```\n" . $pre_content . "```\n\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('pre');
|
||||
}
|
||||
}
|
||||
48
inc/html-to-markdown/src/Converter/TextConverter.php
Executable file
48
inc/html-to-markdown/src/Converter/TextConverter.php
Executable file
|
|
@ -0,0 +1,48 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown\Converter;
|
||||
|
||||
use League\HTMLToMarkdown\ElementInterface;
|
||||
|
||||
class TextConverter implements ConverterInterface
|
||||
{
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function convert(ElementInterface $element)
|
||||
{
|
||||
$markdown = $element->getValue();
|
||||
|
||||
// Remove leftover \n at the beginning of the line
|
||||
$markdown = ltrim($markdown, "\n");
|
||||
|
||||
// Replace sequences of invisible characters with spaces
|
||||
$markdown = preg_replace('~\s+~u', ' ', $markdown);
|
||||
|
||||
// Escape the following characters: '*', '_', '[', ']' and '\'
|
||||
if ($element->getParent() && $element->getParent()->getTagName() !== 'div') {
|
||||
$markdown = preg_replace('~([*_\\[\\]\\\\])~u', '\\\\$1', $markdown);
|
||||
}
|
||||
|
||||
$markdown = preg_replace('~^#~u', '\\\\#', $markdown);
|
||||
|
||||
if ($markdown === ' ') {
|
||||
$next = $element->getNext();
|
||||
if (!$next || $next->isBlock()) {
|
||||
$markdown = '';
|
||||
}
|
||||
}
|
||||
|
||||
return $markdown;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getSupportedTags()
|
||||
{
|
||||
return array('#text');
|
||||
}
|
||||
}
|
||||
257
inc/html-to-markdown/src/Element.php
Executable file
257
inc/html-to-markdown/src/Element.php
Executable file
|
|
@ -0,0 +1,257 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown;
|
||||
|
||||
class Element implements ElementInterface
|
||||
{
|
||||
/**
|
||||
* @var \DOMNode
|
||||
*/
|
||||
protected $node;
|
||||
|
||||
/**
|
||||
* @var ElementInterface|null
|
||||
*/
|
||||
private $nextCached;
|
||||
|
||||
public function __construct(\DOMNode $node)
|
||||
{
|
||||
$this->node = $node;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public function isBlock()
|
||||
{
|
||||
switch ($this->getTagName()) {
|
||||
case 'blockquote':
|
||||
case 'body':
|
||||
case 'code':
|
||||
case 'div':
|
||||
case 'h1':
|
||||
case 'h2':
|
||||
case 'h3':
|
||||
case 'h4':
|
||||
case 'h5':
|
||||
case 'h6':
|
||||
case 'hr':
|
||||
case 'html':
|
||||
case 'li':
|
||||
case 'p':
|
||||
case 'ol':
|
||||
case 'ul':
|
||||
return true;
|
||||
default:
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public function isText()
|
||||
{
|
||||
return $this->getTagName() === '#text';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public function isWhitespace()
|
||||
{
|
||||
return $this->getTagName() === '#text' && trim($this->getValue()) === '';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getTagName()
|
||||
{
|
||||
return $this->node->nodeName;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getValue()
|
||||
{
|
||||
return $this->node->nodeValue;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return ElementInterface|null
|
||||
*/
|
||||
public function getParent()
|
||||
{
|
||||
return new static($this->node->parentNode) ?: null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public function hasChildren()
|
||||
{
|
||||
return $this->node->hasChildNodes();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return ElementInterface[]
|
||||
*/
|
||||
public function getChildren()
|
||||
{
|
||||
$ret = array();
|
||||
/** @var \DOMNode $node */
|
||||
foreach ($this->node->childNodes as $node) {
|
||||
$ret[] = new static($node);
|
||||
}
|
||||
|
||||
return $ret;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return ElementInterface|null
|
||||
*/
|
||||
public function getNext()
|
||||
{
|
||||
if ($this->nextCached === null) {
|
||||
$nextNode = $this->getNextNode($this->node);
|
||||
if ($nextNode !== null) {
|
||||
$this->nextCached = new static($nextNode);
|
||||
}
|
||||
}
|
||||
|
||||
return $this->nextCached;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param \DomNode $node
|
||||
* @param bool $checkChildren
|
||||
*
|
||||
* @return \DomNode|null
|
||||
*/
|
||||
private function getNextNode($node, $checkChildren = true)
|
||||
{
|
||||
if ($checkChildren && $node->firstChild) {
|
||||
return $node->firstChild;
|
||||
}
|
||||
|
||||
if ($node->nextSibling) {
|
||||
return $node->nextSibling;
|
||||
}
|
||||
|
||||
if ($node->parentNode) {
|
||||
return $this->getNextNode($node->parentNode, false);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string[]|string $tagNames
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isDescendantOf($tagNames)
|
||||
{
|
||||
if (!is_array($tagNames)) {
|
||||
$tagNames = array($tagNames);
|
||||
}
|
||||
|
||||
for ($p = $this->node->parentNode; $p !== false; $p = $p->parentNode) {
|
||||
if (is_null($p)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (in_array($p->nodeName, $tagNames)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $markdown
|
||||
*/
|
||||
public function setFinalMarkdown($markdown)
|
||||
{
|
||||
$markdown_node = $this->node->ownerDocument->createTextNode($markdown);
|
||||
$this->node->parentNode->replaceChild($markdown_node, $this->node);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getChildrenAsString()
|
||||
{
|
||||
return $this->node->C14N();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return int
|
||||
*/
|
||||
public function getSiblingPosition()
|
||||
{
|
||||
$position = 0;
|
||||
|
||||
// Loop through all nodes and find the given $node
|
||||
foreach ($this->getParent()->getChildren() as $current_node) {
|
||||
if (!$current_node->isWhitespace()) {
|
||||
$position++;
|
||||
}
|
||||
|
||||
// TODO: Need a less-buggy way of comparing these
|
||||
// Perhaps we can somehow ensure that we always have the exact same object and use === instead?
|
||||
if ($this->equals($current_node)) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return $position;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return int
|
||||
*/
|
||||
public function getListItemLevel()
|
||||
{
|
||||
$level = 0;
|
||||
$parent = $this->getParent();
|
||||
|
||||
while ($parent !== null && $parent->node->parentNode) {
|
||||
if ($parent->getTagName() === 'li') {
|
||||
$level++;
|
||||
}
|
||||
$parent = $parent->getParent();
|
||||
}
|
||||
|
||||
return $level;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $name
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getAttribute($name)
|
||||
{
|
||||
if ($this->node instanceof \DOMElement) {
|
||||
return $this->node->getAttribute($name);
|
||||
}
|
||||
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function equals(ElementInterface $element)
|
||||
{
|
||||
if ($element instanceof self) {
|
||||
return $element->node === $this->node;
|
||||
}
|
||||
|
||||
return $element === $this;
|
||||
}
|
||||
}
|
||||
80
inc/html-to-markdown/src/ElementInterface.php
Executable file
80
inc/html-to-markdown/src/ElementInterface.php
Executable file
|
|
@ -0,0 +1,80 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown;
|
||||
|
||||
interface ElementInterface
|
||||
{
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public function isBlock();
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public function isText();
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public function isWhitespace();
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getTagName();
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getValue();
|
||||
|
||||
/**
|
||||
* @return ElementInterface|null
|
||||
*/
|
||||
public function getParent();
|
||||
|
||||
/**
|
||||
* @param string|string[] $tagNames
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isDescendantOf($tagNames);
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public function hasChildren();
|
||||
|
||||
/**
|
||||
* @return ElementInterface[]
|
||||
*/
|
||||
public function getChildren();
|
||||
|
||||
/**
|
||||
* @return ElementInterface|null
|
||||
*/
|
||||
public function getNext();
|
||||
|
||||
/**
|
||||
* @return int
|
||||
*/
|
||||
public function getSiblingPosition();
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getChildrenAsString();
|
||||
|
||||
/**
|
||||
* @param string $markdown
|
||||
*/
|
||||
public function setFinalMarkdown($markdown);
|
||||
|
||||
/**
|
||||
* @param string $name
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getAttribute($name);
|
||||
}
|
||||
104
inc/html-to-markdown/src/Environment.php
Executable file
104
inc/html-to-markdown/src/Environment.php
Executable file
|
|
@ -0,0 +1,104 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown;
|
||||
|
||||
use League\HTMLToMarkdown\Converter\BlockquoteConverter;
|
||||
use League\HTMLToMarkdown\Converter\CodeConverter;
|
||||
use League\HTMLToMarkdown\Converter\CommentConverter;
|
||||
use League\HTMLToMarkdown\Converter\ConverterInterface;
|
||||
use League\HTMLToMarkdown\Converter\DefaultConverter;
|
||||
use League\HTMLToMarkdown\Converter\DivConverter;
|
||||
use League\HTMLToMarkdown\Converter\EmphasisConverter;
|
||||
use League\HTMLToMarkdown\Converter\HardBreakConverter;
|
||||
use League\HTMLToMarkdown\Converter\HeaderConverter;
|
||||
use League\HTMLToMarkdown\Converter\HorizontalRuleConverter;
|
||||
use League\HTMLToMarkdown\Converter\ImageConverter;
|
||||
use League\HTMLToMarkdown\Converter\LinkConverter;
|
||||
use League\HTMLToMarkdown\Converter\ListBlockConverter;
|
||||
use League\HTMLToMarkdown\Converter\ListItemConverter;
|
||||
use League\HTMLToMarkdown\Converter\ParagraphConverter;
|
||||
use League\HTMLToMarkdown\Converter\PreformattedConverter;
|
||||
use League\HTMLToMarkdown\Converter\TextConverter;
|
||||
|
||||
final class Environment
|
||||
{
|
||||
/**
|
||||
* @var Configuration
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* @var ConverterInterface[]
|
||||
*/
|
||||
protected $converters = array();
|
||||
|
||||
public function __construct(array $config = array())
|
||||
{
|
||||
$this->config = new Configuration($config);
|
||||
$this->addConverter(new DefaultConverter());
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Configuration
|
||||
*/
|
||||
public function getConfig()
|
||||
{
|
||||
return $this->config;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ConverterInterface $converter
|
||||
*/
|
||||
public function addConverter(ConverterInterface $converter)
|
||||
{
|
||||
if ($converter instanceof ConfigurationAwareInterface) {
|
||||
$converter->setConfig($this->config);
|
||||
}
|
||||
|
||||
foreach ($converter->getSupportedTags() as $tag) {
|
||||
$this->converters[$tag] = $converter;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $tag
|
||||
*
|
||||
* @return ConverterInterface
|
||||
*/
|
||||
public function getConverterByTag($tag)
|
||||
{
|
||||
if (isset($this->converters[$tag])) {
|
||||
return $this->converters[$tag];
|
||||
}
|
||||
|
||||
return $this->converters[DefaultConverter::DEFAULT_CONVERTER];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $config
|
||||
*
|
||||
* @return Environment
|
||||
*/
|
||||
public static function createDefaultEnvironment(array $config = array())
|
||||
{
|
||||
$environment = new static($config);
|
||||
|
||||
$environment->addConverter(new BlockquoteConverter());
|
||||
$environment->addConverter(new CodeConverter());
|
||||
$environment->addConverter(new CommentConverter());
|
||||
$environment->addConverter(new DivConverter());
|
||||
$environment->addConverter(new EmphasisConverter());
|
||||
$environment->addConverter(new HardBreakConverter());
|
||||
$environment->addConverter(new HeaderConverter());
|
||||
$environment->addConverter(new HorizontalRuleConverter());
|
||||
$environment->addConverter(new ImageConverter());
|
||||
$environment->addConverter(new LinkConverter());
|
||||
$environment->addConverter(new ListBlockConverter());
|
||||
$environment->addConverter(new ListItemConverter());
|
||||
$environment->addConverter(new ParagraphConverter());
|
||||
$environment->addConverter(new PreformattedConverter());
|
||||
$environment->addConverter(new TextConverter());
|
||||
|
||||
return $environment;
|
||||
}
|
||||
}
|
||||
251
inc/html-to-markdown/src/HtmlConverter.php
Executable file
251
inc/html-to-markdown/src/HtmlConverter.php
Executable file
|
|
@ -0,0 +1,251 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown;
|
||||
|
||||
/**
|
||||
* Class HtmlConverter
|
||||
*
|
||||
* A helper class to convert HTML to Markdown.
|
||||
*
|
||||
* @author Colin O'Dell <colinodell@gmail.com>
|
||||
* @author Nick Cernis <nick@cern.is>
|
||||
*
|
||||
* @link https://github.com/thephpleague/html-to-markdown/ Latest version on GitHub.
|
||||
*
|
||||
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||
*/
|
||||
class HtmlConverter implements HtmlConverterInterface
|
||||
{
|
||||
/**
|
||||
* @var Environment
|
||||
*/
|
||||
protected $environment;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param Environment|array $options Environment object or configuration options
|
||||
*/
|
||||
public function __construct($options = array())
|
||||
{
|
||||
if ($options instanceof Environment) {
|
||||
$this->environment = $options;
|
||||
} elseif (is_array($options)) {
|
||||
$defaults = array(
|
||||
'header_style' => 'setext', // Set to 'atx' to output H1 and H2 headers as # Header1 and ## Header2
|
||||
'suppress_errors' => true, // Set to false to show warnings when loading malformed HTML
|
||||
'strip_tags' => false, // Set to true to strip tags that don't have markdown equivalents. N.B. Strips tags, not their content. Useful to clean MS Word HTML output.
|
||||
'bold_style' => '**', // DEPRECATED: Set to '__' if you prefer the underlined style
|
||||
'italic_style' => '*', // DEPRECATED: Set to '_' if you prefer the underlined style
|
||||
'remove_nodes' => '', // space-separated list of dom nodes that should be removed. example: 'meta style script'
|
||||
'hard_break' => false, // Set to true to turn <br> into `\n` instead of ` \n`
|
||||
'list_item_style' => '-', // Set the default character for each <li> in a <ul>. Can be '-', '*', or '+'
|
||||
);
|
||||
|
||||
$this->environment = Environment::createDefaultEnvironment($defaults);
|
||||
|
||||
$this->environment->getConfig()->merge($options);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Environment
|
||||
*/
|
||||
public function getEnvironment()
|
||||
{
|
||||
return $this->environment;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Configuration
|
||||
*/
|
||||
public function getConfig()
|
||||
{
|
||||
return $this->environment->getConfig();
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert
|
||||
*
|
||||
* @see HtmlConverter::convert
|
||||
*
|
||||
* @param string $html
|
||||
*
|
||||
* @return string The Markdown version of the html
|
||||
*/
|
||||
public function __invoke($html)
|
||||
{
|
||||
return $this->convert($html);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert
|
||||
*
|
||||
* Loads HTML and passes to getMarkdown()
|
||||
*
|
||||
* @param string $html
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
*
|
||||
* @return string The Markdown version of the html
|
||||
*/
|
||||
public function convert($html)
|
||||
{
|
||||
if (trim($html) === '') {
|
||||
return '';
|
||||
}
|
||||
|
||||
$document = $this->createDOMDocument($html);
|
||||
|
||||
// Work on the entire DOM tree (including head and body)
|
||||
if (!($root = $document->getElementsByTagName('html')->item(0))) {
|
||||
throw new \InvalidArgumentException('Invalid HTML was provided');
|
||||
}
|
||||
|
||||
$rootElement = new Element($root);
|
||||
$this->convertChildren($rootElement);
|
||||
|
||||
// Store the now-modified DOMDocument as a string
|
||||
$markdown = $document->saveHTML();
|
||||
|
||||
return $this->sanitize($markdown);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $html
|
||||
*
|
||||
* @return \DOMDocument
|
||||
*/
|
||||
private function createDOMDocument($html)
|
||||
{
|
||||
$document = new \DOMDocument();
|
||||
|
||||
if ($this->getConfig()->getOption('suppress_errors')) {
|
||||
// Suppress conversion errors (from http://bit.ly/pCCRSX)
|
||||
libxml_use_internal_errors(true);
|
||||
}
|
||||
|
||||
// Hack to load utf-8 HTML (from http://bit.ly/pVDyCt)
|
||||
$document->loadHTML('<?xml encoding="UTF-8">' . $html);
|
||||
$document->encoding = 'UTF-8';
|
||||
|
||||
if ($this->getConfig()->getOption('suppress_errors')) {
|
||||
libxml_clear_errors();
|
||||
}
|
||||
|
||||
return $document;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert Children
|
||||
*
|
||||
* Recursive function to drill into the DOM and convert each node into Markdown from the inside out.
|
||||
*
|
||||
* Finds children of each node and convert those to #text nodes containing their Markdown equivalent,
|
||||
* starting with the innermost element and working up to the outermost element.
|
||||
*
|
||||
* @param ElementInterface $element
|
||||
*/
|
||||
private function convertChildren(ElementInterface $element)
|
||||
{
|
||||
// Don't convert HTML code inside <code> and <pre> blocks to Markdown - that should stay as HTML
|
||||
// except if the current node is a code tag, which needs to be converted by the CodeConverter.
|
||||
if ($element->isDescendantOf(array('pre', 'code')) && $element->getTagName() !== 'code') {
|
||||
return;
|
||||
}
|
||||
|
||||
// If the node has children, convert those to Markdown first
|
||||
if ($element->hasChildren()) {
|
||||
foreach ($element->getChildren() as $child) {
|
||||
$this->convertChildren($child);
|
||||
}
|
||||
}
|
||||
|
||||
// Now that child nodes have been converted, convert the original node
|
||||
$markdown = $this->convertToMarkdown($element);
|
||||
|
||||
// Create a DOM text node containing the Markdown equivalent of the original node
|
||||
|
||||
// Replace the old $node e.g. '<h3>Title</h3>' with the new $markdown_node e.g. '### Title'
|
||||
$element->setFinalMarkdown($markdown);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert to Markdown
|
||||
*
|
||||
* Converts an individual node into a #text node containing a string of its Markdown equivalent.
|
||||
*
|
||||
* Example: An <h3> node with text content of 'Title' becomes a text node with content of '### Title'
|
||||
*
|
||||
* @param ElementInterface $element
|
||||
*
|
||||
* @return string The converted HTML as Markdown
|
||||
*/
|
||||
protected function convertToMarkdown(ElementInterface $element)
|
||||
{
|
||||
$tag = $element->getTagName();
|
||||
|
||||
// Strip nodes named in remove_nodes
|
||||
$tags_to_remove = explode(' ', $this->getConfig()->getOption('remove_nodes'));
|
||||
if (in_array($tag, $tags_to_remove)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$converter = $this->environment->getConverterByTag($tag);
|
||||
|
||||
return $converter->convert($element);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $markdown
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function sanitize($markdown)
|
||||
{
|
||||
$markdown = html_entity_decode($markdown, ENT_QUOTES, 'UTF-8');
|
||||
$markdown = preg_replace('/<!DOCTYPE [^>]+>/', '', $markdown); // Strip doctype declaration
|
||||
$markdown = trim($markdown); // Remove blank spaces at the beggining of the html
|
||||
|
||||
/*
|
||||
* Removing unwanted tags. Tags should be added to the array in the order they are expected.
|
||||
* XML, html and body opening tags should be in that order. Same case with closing tags
|
||||
*/
|
||||
$unwanted = array('<?xml encoding="UTF-8">', '<html>', '</html>', '<body>', '</body>', '<head>', '</head>', '
');
|
||||
|
||||
foreach ($unwanted as $tag) {
|
||||
if (strpos($tag, '/') === false) {
|
||||
// Opening tags
|
||||
if (strpos($markdown, $tag) === 0) {
|
||||
$markdown = substr($markdown, strlen($tag));
|
||||
}
|
||||
} else {
|
||||
// Closing tags
|
||||
if (strpos($markdown, $tag) === strlen($markdown) - strlen($tag)) {
|
||||
$markdown = substr($markdown, 0, -strlen($tag));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return trim($markdown, "\n\r\0\x0B");
|
||||
}
|
||||
|
||||
/**
|
||||
* Pass a series of key-value pairs in an array; these will be passed
|
||||
* through the config and set.
|
||||
* The advantage of this is that it can allow for static use (IE in Laravel).
|
||||
* An example being:
|
||||
*
|
||||
* HtmlConverter::setOptions(['strip_tags' => true])->convert('<h1>test</h1>');
|
||||
*/
|
||||
public function setOptions(array $options)
|
||||
{
|
||||
$config = $this->getConfig();
|
||||
|
||||
foreach ($options as $key => $option) {
|
||||
$config->setOption($key, $option);
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
26
inc/html-to-markdown/src/HtmlConverterInterface.php
Executable file
26
inc/html-to-markdown/src/HtmlConverterInterface.php
Executable file
|
|
@ -0,0 +1,26 @@
|
|||
<?php
|
||||
|
||||
namespace League\HTMLToMarkdown;
|
||||
|
||||
/**
|
||||
* Interface for an HTML-to-Markdown converter.
|
||||
*
|
||||
* @author Colin O'Dell <colinodell@gmail.com>
|
||||
*
|
||||
* @link https://github.com/thephpleague/html-to-markdown/ Latest version on GitHub.
|
||||
*
|
||||
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||
*/
|
||||
interface HtmlConverterInterface
|
||||
{
|
||||
/**
|
||||
* Convert the given $html to Markdown
|
||||
*
|
||||
* @param string $html
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
*
|
||||
* @return string The Markdown version of the html
|
||||
*/
|
||||
public function convert($html);
|
||||
}
|
||||
Loading…
Reference in a new issue