├── .github
    ├── FUNDING.yml
    ├── ISSUE_TEMPLATE
    │   ├── 1_Conversion_error.yaml
    │   ├── 2_Bug_report.yaml
    │   └── 3_Feature_request.yaml
    ├── SECURITY.md
    ├── renovate.json
    ├── stale.yml
    └── workflows
    │   └── tests.yml
├── CHANGELOG.md
├── CONDUCT.md
├── LICENSE
├── README.md
├── bin
    └── html-to-markdown
├── composer.json
├── phpcs.xml.dist
├── phpstan.neon.dist
├── psalm.xml
└── src
    ├── Coerce.php
    ├── Configuration.php
    ├── ConfigurationAwareInterface.php
    ├── Converter
        ├── BlockquoteConverter.php
        ├── CodeConverter.php
        ├── CommentConverter.php
        ├── ConverterInterface.php
        ├── DefaultConverter.php
        ├── DivConverter.php
        ├── EmphasisConverter.php
        ├── HardBreakConverter.php
        ├── HeaderConverter.php
        ├── HorizontalRuleConverter.php
        ├── ImageConverter.php
        ├── LinkConverter.php
        ├── ListBlockConverter.php
        ├── ListItemConverter.php
        ├── ParagraphConverter.php
        ├── PreformattedConverter.php
        ├── TableConverter.php
        └── TextConverter.php
    ├── Element.php
    ├── ElementInterface.php
    ├── Environment.php
    ├── HtmlConverter.php
    ├── HtmlConverterInterface.php
    └── PreConverterInterface.php


/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | github: colinodell
2 | tidelift: "packagist/league/html-to-markdown"
3 | custom: ["https://www.colinodell.com/sponsor", "https://www.paypal.me/colinpodell/10.00"]
4 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/1_Conversion_error.yaml:
--------------------------------------------------------------------------------
 1 | name: "📃 Bug Report (Incorrect Markdown)"
 2 | description: I'm not getting the Markdown I expect
 3 | body:
 4 |     - type: input
 5 |       id: affected-versions
 6 |       attributes:
 7 |           label: Version(s) affected
 8 |           placeholder: x.y.z
 9 |       validations:
10 |           required: true
11 |     - type: textarea
12 |       id: description
13 |       attributes:
14 |           label: Description
15 |           description: A clear and concise description of the problem.
16 |       validations:
17 |           required: true
18 |     - type: textarea
19 |       id: how-to-reproduce
20 |       attributes:
21 |           label: How to reproduce
22 |           description: |
23 |               Provide the HTML input and any other information that would help us reproduce the problem.
24 |       validations:
25 |           required: true
26 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/2_Bug_report.yaml:
--------------------------------------------------------------------------------
 1 | name: "🐛 Bug Report (Other)"
 2 | description: Report all other errors and problems
 3 | body:
 4 |     - type: input
 5 |       id: affected-versions
 6 |       attributes:
 7 |           label: Version(s) affected
 8 |           placeholder: x.y.z
 9 |       validations:
10 |           required: true
11 |     - type: textarea
12 |       id: description
13 |       attributes:
14 |           label: Description
15 |           description: A clear and concise description of the problem.
16 |       validations:
17 |           required: true
18 |     - type: textarea
19 |       id: how-to-reproduce
20 |       attributes:
21 |           label: How to reproduce
22 |           description: |
23 |               HTML and/or any other information needed to reproduce the problem.
24 |       validations:
25 |           required: true
26 |     - type: textarea
27 |       id: possible-solution
28 |       attributes:
29 |           label: Possible solution
30 |           description: |
31 |               Optional: only if you have suggestions on a fix/reason for the bug
32 |     - type: textarea
33 |       id: additional-context
34 |       attributes:
35 |           label: Additional context
36 |           description: |
37 |               Optional: any other context about the problem: log messages, screenshots, etc.
38 |     - type: textarea
39 |       id: feedback
40 |       attributes:
41 |           label: Did this project help you today? Did it make you happy in any way?
42 |           description: |
43 |               Optional: Sometimes we get tired of reading bug reports and working on complex features, so if you have anything positive to share about how this library might have helped you we'd love to hear it!
44 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/3_Feature_request.yaml:
--------------------------------------------------------------------------------
 1 | name: "🚀 Feature Request"
 2 | description: RFC and ideas for new features and improvements
 3 | labels:
 4 |     - enhancement
 5 | body:
 6 |     - type: textarea
 7 |       id: description
 8 |       attributes:
 9 |           label: Description
10 |           description: A clear and concise description of the problem.
11 |       validations:
12 |           required: true
13 |     - type: textarea
14 |       id: example
15 |       attributes:
16 |           label: Example
17 |           description: |
18 |               A simple example of the new feature in action (include PHP code, sample HTML/Markdown, etc.)
19 |               If the new feature changes an existing feature, include a simple before/after comparison.
20 |       validations:
21 |           required: true
22 |     - type: textarea
23 |       id: feedback
24 |       attributes:
25 |           label: Did this project help you today? Did it make you happy in any way?
26 |           description: |
27 |               Optional: Sometimes we get tired of reading bug reports and working on complex features, so if you have anything positive to share about how this library might have helped you we'd love to hear it!
28 | 


--------------------------------------------------------------------------------
/.github/SECURITY.md:
--------------------------------------------------------------------------------
 1 | # SECURITY POLICY
 2 | 
 3 | ## Supported Versions
 4 | 
 5 | When a new **minor** version (`5.x`) is released, the previous one will continue to receive security and bug fixes for *at least* 3 months.
 6 | 
 7 | When a new **major** version is released (`4.0`, `5.0`, etc), the previous one will receive bug fixes for *at least* 3 months and security updates for 6 months after that new release comes out.
 8 | 
 9 | (This policy may change in the future and exceptions may be made on a case-by-case basis.)
10 | 
11 | ## Reporting a Vulnerability
12 | 
13 | If you discover a security vulnerability within this package, please use the [Tidelift security contact form](https://tidelift.com/security) or email Colin O'Dell at <colinodell@gmail.com>. All security vulnerabilities will be promptly addressed. Please do not disclose security-related issues publicly until a fix has been announced.
14 | 


--------------------------------------------------------------------------------
/.github/renovate.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "$schema": "https://docs.renovatebot.com/renovate-schema.json",
 3 |     "extends": [
 4 |         "config:base",
 5 |         ":disableDependencyDashboard"
 6 |     ],
 7 |     "enabledManagers": ["github-actions", "composer"],
 8 |     "packageRules": [
 9 |         {
10 |             "matchManagers": ["github-actions"],
11 |             "extends": ["schedule:weekly"],
12 |             "automerge": true
13 |         },
14 |         {
15 |             "matchManagers": ["composer"],
16 |             "matchDepTypes": ["devDependencies"],
17 |             "rangeStrategy": "widen",
18 |             "automerge": true
19 |         },
20 |         {
21 |             "matchManagers": ["composer"],
22 |             "rangeStrategy": "widen"
23 |         }
24 |     ]
25 | }
26 | 


--------------------------------------------------------------------------------
/.github/stale.yml:
--------------------------------------------------------------------------------
 1 | # Number of days of inactivity before an issue becomes stale
 2 | daysUntilStale: 90
 3 | # Number of days of inactivity before a stale issue is closed
 4 | daysUntilClose: 30
 5 | # Issues with these labels will never be considered stale
 6 | exemptLabels:
 7 |   - pinned
 8 |   - on hold
 9 |   - security
10 | # Label to use when marking an issue as stale
11 | staleLabel: stale
12 | # Comment to post when marking an issue as stale. Set to `false` to disable
13 | markComment: >
14 |   This issue has been automatically marked as stale because it has not had
15 |   recent activity. It will be closed if no further activity occurs. Thank you
16 |   for your contributions.
17 | # Comment to post when closing a stale issue. Set to `false` to disable
18 | closeComment: false
19 | 


--------------------------------------------------------------------------------
/.github/workflows/tests.yml:
--------------------------------------------------------------------------------
  1 | name: Tests
  2 | 
  3 | on:
  4 |     push: ~
  5 |     pull_request: ~
  6 | 
  7 | jobs:
  8 |     phpcs:
  9 |         name: PHPCS
 10 |         runs-on: ubuntu-latest
 11 | 
 12 |         steps:
 13 |             - uses: actions/checkout@v4
 14 | 
 15 |             - uses: shivammathur/setup-php@v2
 16 |               with:
 17 |                   php-version: 7.2
 18 |                   extensions: curl, mbstring
 19 |                   coverage: none
 20 |                   tools: composer:v2, cs2pr
 21 | 
 22 |             - run: composer update --no-progress
 23 | 
 24 |             - run: vendor/bin/phpcs -q --report=checkstyle | cs2pr
 25 | 
 26 |     phpunit:
 27 |         name: PHPUnit on ${{ matrix.php }} ${{ matrix.composer-flags }}
 28 |         runs-on: ubuntu-latest
 29 |         strategy:
 30 |             matrix:
 31 |                 php: ['7.2', '7.3', '7.4', '8.0', '8.1']
 32 |                 coverage: [true]
 33 |                 composer-flags: ['']
 34 |                 include:
 35 |                     - php: '8.2'
 36 |                       coverage: false
 37 |                       composer-flags: '--ignore-platform-req=php'
 38 |                     - php: '7.2'
 39 |                       coverage: false
 40 |                       composer-flags: '--prefer-lowest'
 41 | 
 42 |         steps:
 43 |             - uses: actions/checkout@v4
 44 | 
 45 |             - uses: shivammathur/setup-php@v2
 46 |               with:
 47 |                   php-version: ${{ matrix.php }}
 48 |                   extensions: curl, mbstring
 49 |                   coverage: pcov
 50 |                   tools: composer:v2
 51 | 
 52 |             - run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
 53 | 
 54 |             - name: "Use PHPUnit 9.3+ on PHP 8"
 55 |               run: composer require --no-update --dev phpunit/phpunit:^9.3
 56 |               if: "matrix.php >= '8.0'"
 57 | 
 58 |             - run: composer update --no-progress ${{ matrix.composer-flags }}
 59 | 
 60 |             - run: vendor/bin/phpunit --no-coverage
 61 |               if: ${{ !matrix.coverage }}
 62 | 
 63 |             - run: vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
 64 |               if: ${{ matrix.coverage }}
 65 | 
 66 |             - run: php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover
 67 |               if: ${{ matrix.coverage }}
 68 |               continue-on-error: true
 69 | 
 70 |     phpstan:
 71 |         name: PHPStan
 72 |         runs-on: ubuntu-latest
 73 | 
 74 |         steps:
 75 |             - uses: actions/checkout@v4
 76 | 
 77 |             - uses: shivammathur/setup-php@v2
 78 |               with:
 79 |                   php-version: 7.2
 80 |                   extensions: curl, mbstring
 81 |                   coverage: none
 82 |                   tools: composer:v2
 83 | 
 84 |             - run: composer update --no-progress
 85 | 
 86 |             - run: vendor/bin/phpstan analyse --no-progress
 87 | 
 88 |     psalm:
 89 |         name: Psalm
 90 |         runs-on: ubuntu-latest
 91 | 
 92 |         steps:
 93 |             - uses: actions/checkout@v4
 94 | 
 95 |             - uses: shivammathur/setup-php@v2
 96 |               with:
 97 |                   php-version: 7.2
 98 |                   extensions: curl, mbstring
 99 |                   coverage: none
100 |                   tools: composer:v2
101 | 
102 |             - run: composer update --no-progress
103 | 
104 |             - run: vendor/bin/psalm --no-progress --output-format=github
105 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
  1 | # Change Log
  2 | All notable changes to this project will be documented in this file.
  3 | Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
  4 | 
  5 | ## [Unreleased][unreleased]
  6 | 
  7 | ## [5.1.1] - 2023-07-12
  8 | 
  9 | ### Fixed
 10 | 
 11 | - Fixed `<pre>` tags with attributes not being parsed (#215, #238)
 12 | - Fixed missing type checks and coercions
 13 | 
 14 | ## [5.1.0] - 2022-03-02
 15 | 
 16 | ### Changed
 17 | 
 18 |  - Changed horizontal rule style (#218, #219)
 19 | 
 20 | ### Fixed
 21 | 
 22 |  - Fixed `Element::getValue()` not handling possible nulls
 23 | 
 24 | ## [5.0.2] - 2021-11-06
 25 | 
 26 | ### Fixed
 27 | 
 28 |  - Fixed missplaced comment nodes appearing at the start of the HTML input (#212)
 29 | 
 30 | ## [5.0.1] - 2021-09-17
 31 | 
 32 | ### Fixed
 33 | 
 34 |  - Fixed lists not using the correct amount of indentation (#211)
 35 | 
 36 | ## [5.0.0] - 2021-03-28
 37 | 
 38 | ### Added
 39 | 
 40 |  - Added support for tables (#203)
 41 |     - This feature is disable by default - see README for how to enable it
 42 |  - Added new `strip_placeholder_links` option to strip `<a>` tags without `href` attributes (#196)
 43 |  - Added new methods to `ElementInterface`:
 44 |     - `hasParent()`
 45 |     - `getNextSibling()`
 46 |     - `getPreviousSibling()`
 47 |     - `getListItemLevel()`
 48 |  - Added several parameter and return types across all classes
 49 |  - Added new `PreConverterInterface` to allow converters to perform any necessary pre-parsing
 50 | 
 51 | ### Changed
 52 | 
 53 |  - Supported PHP versions increased to PHP 7.2 - 8.0
 54 |  - `HtmlConverter::convert()` may now throw a `\RuntimeException` when unexpected `DOMDocument`-related errors occur
 55 | 
 56 | ### Fixed
 57 | 
 58 |  - Fixed complex nested lists containing heading and paragraphs (#198)
 59 |  - Fixed consecutive emphasis producing incorrect markdown (#202)
 60 | 
 61 | ## [4.10.0] - 2020-06-30
 62 | ### Added
 63 | 
 64 |  - Added the ability to disable autolinking with a configuration option (#187, #188)
 65 | 
 66 | ## [4.9.1] - 2019-12-27
 67 | ### Fixed
 68 |  - Fixed issue with HTML entity escaping in text (#184)
 69 | 
 70 | ## [4.9.0] - 2019-11-02
 71 | ### Added
 72 |  - Added new option to preserve comments (#177, #179)
 73 | 
 74 | ## [4.8.3] - 2019-10-31
 75 | ### Fixed
 76 |  - Fixed whitespace preservation around `<code>` tags (#174, #178)
 77 | 
 78 | ## [4.8.2] - 2019-08-02
 79 | ### Fixed
 80 |  - Fixed headers not being placed onto a new line in some cases (#172)
 81 |  - Fixed handling of links containing spaces (#175)
 82 | 
 83 | ### Removed
 84 |  - Removed support for HHVM
 85 | 
 86 | ## [4.8.1] - 2018-12-24
 87 | ### Added
 88 |  - Added support for PHP 7.3
 89 | 
 90 | ### Fixed
 91 |  - Fixed paragraphs following tables (#165, #166)
 92 |  - Fixed incorrect list item escaping (#168, #169)
 93 | 
 94 | ## [4.8.0] - 2018-09-18
 95 | ### Added
 96 |  - Added support for email auto-linking
 97 |  - Added a new interface (`HtmlConverterInterface`) for the main `HtmlConverter` class
 98 |  - Added additional test cases (#14)
 99 | 
100 | ### Changed
101 |  - The `italic_style` option now defaults to `'*'` so that in-word emphasis is handled properly (#75)
102 | 
103 | ### Fixed
104 |  - Fixed several issues of `<code>` and `<pre>` tags not converting to blocks or inlines properly (#26, #70, #102, #140, #161, #162)
105 |  - Fixed in-word emphasis using underscores as delimiter (#75)
106 |  - Fixed character escaping inside of `<div>` elements
107 |  - Fixed header edge cases
108 | 
109 | ### Deprecated
110 |  - The `bold_style` and `italic_style` options have been deprecated (#75)
111 | 
112 | ## [4.7.0] - 2018-05-19
113 | ### Added
114 |  - Added `setOptions()` function for chainable calling (#149)
115 |  - Added new `list_item_style_alternate` option for converting every-other list with a different character (#155)
116 | 
117 | ### Fixed
118 |  - Fixed insufficient newlines after code blocks (#144, #148)
119 |  - Fixed trailing spaces not being preserved in link anchors (#157)
120 |  - Fixed list-like lines not being escaped inside of lists items (#159)
121 | 
122 | ## [4.6.2]
123 | ### Fixed
124 |  - Fixed issue with emphasized spaces (#146)
125 | 
126 | ## [4.6.1]
127 | ### Fixed
128 |  - Fixed conversion of `<pre>` tags (#145)
129 | 
130 | ## [4.6.0]
131 | ### Added
132 |  - Added support for ordered lists starting at numbers other than 1
133 | 
134 | ### Fixed
135 |  - Fixed overly-eager escaping of list-like text (#141)
136 | 
137 | ## [4.5.0]
138 | ### Added
139 |  - Added configuration option for list item style (#135, #136)
140 | 
141 | ## [4.4.1]
142 | 
143 | ### Fixed
144 |  - Fixed autolinking of invalid URLs (#129)
145 | 
146 | ## [4.4.0]
147 | 
148 | ### Added
149 |  - Added `hard_break` configuration option (#112, #115)
150 |  - The `HtmlConverter` can now be instantiated with an `Environment` (#118)
151 | 
152 | ### Fixed
153 |  - Fixed handling of paragraphs in list item elements (#47, #110)
154 |  - Fixed phantom spaces when newlines follow `br` elements (#116, #117)
155 |  - Fixed link converter not sanitizing inner spaces properly (#119, #120)
156 | 
157 | ## [4.3.1]
158 | ### Changed
159 |  - Revised the sanitization implementation (#109)
160 | 
161 | ### Fixed
162 |  - Fixed tag-like content not being escaped (#67, #109)
163 |  - Fixed thematic break-like content not being escaped (#65, #109)
164 |  - Fixed codefence-like content not being escaped (#64, #109)
165 | 
166 | ## [4.3.0]
167 | ### Added
168 |  - Added full support for PHP 7.0 and 7.1
169 | 
170 | ### Changed
171 |  - Changed `<pre>` and `<pre><code>` conversions to use backticks instead of indendation (#102)
172 | 
173 | ### Fixed
174 |  - Fixed issue where specified code language was not preserved (#70, #102)
175 |  - Fixed issue where `<code>` tags nested in `<pre>` was not converted properly (#70, #102)
176 |  - Fixed header-like content not being escaped (#76, #105)
177 |  - Fixed blockquote-like content not being escaped (#77, #103)
178 |  - Fixed ordered list-like content not being escaped (#73, #106)
179 |  - Fixed unordered list-like content not being escaped (#71, #107)
180 | 
181 | ## [4.2.2]
182 | ### Fixed
183 |  - Fixed sanitization bug which sometimes removes desired content (#63, #101)
184 | 
185 | ## [4.2.1]
186 | ### Fixed
187 |  - Fixed path to autoload.php when used as a library (#98)
188 |  - Fixed edge case for tags containing only whitespace (#99)
189 | 
190 | ### Removed
191 |  - Removed double HTML entity decoding, as this is not desireable (#60)
192 | 
193 | ## [4.2.0]
194 | 
195 | ### Added
196 |  - Added the ability to invoke HtmlConverter objects as functions (#85)
197 | 
198 | ### Fixed
199 |  - Fixed improper handling of nested list items (#19 and #84)
200 |  - Fixed preceeding or trailing spaces within emphasis tags (#83)
201 | 
202 | ## [4.1.1]
203 | 
204 | ### Fixed
205 |  - Fixed conversion of empty paragraphs (#78)
206 |  - Fixed `preg_replace` so it wouldn't break UTF-8 characters (#79)
207 | 
208 | ## [4.1.0]
209 | 
210 | ### Added
211 |  - Added `bin/html-to-markdown` script
212 | 
213 | ### Changed
214 |  - Changed default italic character to `_` (#58)
215 | 
216 | ## [4.0.1]
217 | 
218 | ### Fixed
219 |  - Added escaping to avoid * and _ in a text being rendered as emphasis (#48)
220 | 
221 | ### Removed
222 |  - Removed the demo (#51)
223 |  - `.styleci.yml` and `CONTRIBUTING.md` are no longer included in distributions (#50)
224 | 
225 | ## [4.0.0]
226 | 
227 | This release changes the visibility of several methods/properties. #42 and #43 brought to light that some visiblities were
228 | not ideally set, so this releases fixes that. Moving forwards this should reduce the chance of introducing BC-breaking changes.
229 | 
230 | ### Added
231 |  - Added new `HtmlConverter::getEnvironment()` method to expose the `Environment` (#42, #43)
232 | 
233 | ### Changed
234 |  - Changed `Environment::addConverter()` from `protected` to `public`, enabling custom converters to be added (#42, #43)
235 |  - Changed `HtmlConverter::createDOMDocument()` from `protected` to `private`
236 |  - Changed `Element::nextCached` from `protected` to `private`
237 |  - Made the `Environment` class `final`
238 | 
239 | ## [3.1.1]
240 | ### Fixed
241 |  - Empty HTML strings now result in empty Markdown documents (#40, #41)
242 | 
243 | ## [3.1.0]
244 | ### Added
245 |  - Added new `equals` method to `Element` to check for equality
246 | 
247 | ### Changes
248 |  - Use Linux line endings consistently instead of plaform-specific line endings (#36)
249 | 
250 | ### Fixed
251 |  - Cleaned up code style
252 | 
253 | ## [3.0.0]
254 | ### Changed
255 |  - Changed namespace to `League\HTMLToMarkdown`
256 |  - Changed packagist name to `league/html-to-markdown`
257 |  - Re-organized code into several separate classes
258 |  - `<a>` tags with identical href and inner text are now rendered using angular bracket syntax (#31)
259 |  - `<div>` elements are now treated as block-level elements (#33)
260 | 
261 | ## [2.2.2]
262 | ### Added
263 |  - Added support for PHP 5.6 and HHVM
264 |  - Enabled testing against PHP 7 nightlies
265 |  - Added this CHANGELOG.md
266 | 
267 | ### Fixed
268 |  - Fixed whitespace preservation between inline elements (#9 and #10)
269 | 
270 | ## [2.2.1]
271 | ### Fixed
272 |  - Preserve placeholder links (#22)
273 | 
274 | ## [2.2.0]
275 | ### Added
276 |  - Added CircleCI config
277 | 
278 | ### Changed
279 |  - `<pre>` blocks are now treated as code elements
280 | 
281 | ### Removed
282 |  - Dropped support for PHP 5.2
283 |  - Removed incorrect README comment regarding `#text` nodes (#17)
284 | 
285 | ## [2.1.2]
286 | ### Added
287 |  - Added the ability to blacklist/remove specific node types (#11)
288 | 
289 | ### Changed
290 |  - Line breaks are now placed after divs instead of before them
291 |  - Newlines inside of link texts are now removed
292 |  - Updated the minimum PHPUnit version to 4.*
293 | 
294 | ## [2.1.1]
295 | ### Added
296 |  - Added options to customize emphasis characters
297 | 
298 | ## [2.1.0]
299 | ### Added
300 |  - Added option to strip HTML tags without Markdown equivalents
301 |  - Added `convert()` method for converter reuse
302 |  - Added ability to set options after instance construction
303 |  - Documented the required PHP extensions (#4)
304 | 
305 | ### Changed
306 |  - ATX style now used for h1 and h2 tags inside blockquotes
307 | 
308 | ### Fixed
309 |  - Newlines inside blockquotes are now started with a bracket
310 |  - Fixed some incorrect docblocks
311 |  - `__toString()` now returns an empty string if input is empty
312 |  - Convert head tag if body tag is empty (#7)
313 |  - Preserve special characters inside tags without md equivalents (#6)
314 | 
315 | 
316 | ## [2.0.1]
317 | ### Fixed
318 |  - Fixed first line indentation for multi-line code blocks
319 |  - Fixed consecutive anchors get separating spaces stripped (#3)
320 | 
321 | ## [2.0.0]
322 | ### Added
323 |  - Initial release
324 | 
325 | [unreleased]: https://github.com/thephpleague/html-to-markdown/compare/5.1.1...master
326 | [5.1.1]: https://github.com/thephpleague/html-to-markdown/compare/5.1.0...5.1.1
327 | [5.1.0]: https://github.com/thephpleague/html-to-markdown/compare/5.0.2...5.1.0
328 | [5.0.2]: https://github.com/thephpleague/html-to-markdown/compare/5.0.1...5.0.2
329 | [5.0.1]: https://github.com/thephpleague/html-to-markdown/compare/5.0.0...5.0.1
330 | [5.0.0]: https://github.com/thephpleague/html-to-markdown/compare/4.10.0...5.0.0
331 | [4.10.0]: https://github.com/thephpleague/html-to-markdown/compare/4.9.1...4.10.0
332 | [4.9.1]: https://github.com/thephpleague/html-to-markdown/compare/4.9.0...4.9.1
333 | [4.9.0]: https://github.com/thephpleague/html-to-markdown/compare/4.8.3...4.9.0
334 | [4.8.3]: https://github.com/thephpleague/html-to-markdown/compare/4.8.2...4.8.3
335 | [4.8.2]: https://github.com/thephpleague/html-to-markdown/compare/4.8.1...4.8.2
336 | [4.8.1]: https://github.com/thephpleague/html-to-markdown/compare/4.8.0...4.8.1
337 | [4.8.0]: https://github.com/thephpleague/html-to-markdown/compare/4.7.0...4.8.0
338 | [4.7.0]: https://github.com/thephpleague/html-to-markdown/compare/4.6.2...4.7.0
339 | [4.6.2]: https://github.com/thephpleague/html-to-markdown/compare/4.6.1...4.6.2
340 | [4.6.1]: https://github.com/thephpleague/html-to-markdown/compare/4.6.0...4.6.1
341 | [4.6.0]: https://github.com/thephpleague/html-to-markdown/compare/4.5.0...4.6.0
342 | [4.5.0]: https://github.com/thephpleague/html-to-markdown/compare/4.4.1...4.5.0
343 | [4.4.1]: https://github.com/thephpleague/html-to-markdown/compare/4.4.0...4.4.1
344 | [4.4.0]: https://github.com/thephpleague/html-to-markdown/compare/4.3.1...4.4.0
345 | [4.3.1]: https://github.com/thephpleague/html-to-markdown/compare/4.3.0...4.3.1
346 | [4.3.0]: https://github.com/thephpleague/html-to-markdown/compare/4.2.2...4.3.0
347 | [4.2.2]: https://github.com/thephpleague/html-to-markdown/compare/4.2.1...4.2.2
348 | [4.2.1]: https://github.com/thephpleague/html-to-markdown/compare/4.2.0...4.2.1
349 | [4.2.0]: https://github.com/thephpleague/html-to-markdown/compare/4.1.1...4.2.0
350 | [4.1.1]: https://github.com/thephpleague/html-to-markdown/compare/4.1.0...4.1.1
351 | [4.1.0]: https://github.com/thephpleague/html-to-markdown/compare/4.0.1...4.1.0
352 | [4.0.1]: https://github.com/thephpleague/html-to-markdown/compare/4.0.0...4.0.1
353 | [4.0.0]: https://github.com/thephpleague/html-to-markdown/compare/3.1.1...4.0.0
354 | [3.1.1]: https://github.com/thephpleague/html-to-markdown/compare/3.1.0...3.1.1
355 | [3.1.0]: https://github.com/thephpleague/html-to-markdown/compare/3.0.0...3.1.0
356 | [3.0.0]: https://github.com/thephpleague/html-to-markdown/compare/2.2.2...3.0.0
357 | [2.2.2]: https://github.com/thephpleague/html-to-markdown/compare/2.2.1...2.2.2
358 | [2.2.1]: https://github.com/thephpleague/html-to-markdown/compare/2.2.0...2.2.1
359 | [2.2.0]: https://github.com/thephpleague/html-to-markdown/compare/2.1.2...2.2.0
360 | [2.1.2]: https://github.com/thephpleague/html-to-markdown/compare/2.1.1...2.1.2
361 | [2.1.1]: https://github.com/thephpleague/html-to-markdown/compare/2.1.0...2.1.1
362 | [2.1.0]: https://github.com/thephpleague/html-to-markdown/compare/2.0.1...2.1.0
363 | [2.0.1]: https://github.com/thephpleague/html-to-markdown/compare/2.0.0...2.0.1
364 | [2.0.0]: https://github.com/thephpleague/html-to-markdown/compare/775f91e...2.0.0
365 | 
366 | 


--------------------------------------------------------------------------------
/CONDUCT.md:
--------------------------------------------------------------------------------
 1 | # Contributor Code of Conduct
 2 | 
 3 | 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.
 4 | 
 5 | 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.
 6 | 
 7 | Examples of unacceptable behavior by participants include:
 8 | 
 9 | * The use of sexualized language or imagery
10 | * Personal attacks
11 | * Trolling or insulting/derogatory comments
12 | * Public or private harassment
13 | * Publishing other's private information, such as physical or electronic addresses, without explicit permission
14 | * Other unethical or unprofessional conduct.
15 | 
16 | 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.
17 | 
18 | This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
19 | 
20 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
21 | 
22 | 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/)
23 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2015 Colin O'Dell; Originally created by Nick Cernis
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of
 6 | this software and associated documentation files (the "Software"), to deal in
 7 | the Software without restriction, including without limitation the rights to
 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 9 | the Software, and to permit persons to whom the Software is furnished to do so,
10 | subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | HTML To Markdown for PHP
  2 | ========================
  3 | 
  4 | [![Latest Version](https://img.shields.io/packagist/v/league/html-to-markdown.svg?style=flat-square)](https://packagist.org/packages/league/html-to-markdown)
  5 | [![Software License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
  6 | [![Build Status](https://img.shields.io/github/workflow/status/thephpleague/html-to-markdown/Tests/master.svg?style=flat-square)](https://github.com/thephpleague/html-to-markdown/actions?query=workflow%3ATests+branch%3Amaster)
  7 | [![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/thephpleague/html-to-markdown.svg?style=flat-square)](https://scrutinizer-ci.com/g/thephpleague/html-to-markdown/code-structure)
  8 | [![Quality Score](https://img.shields.io/scrutinizer/g/thephpleague/html-to-markdown.svg?style=flat-square)](https://scrutinizer-ci.com/g/thephpleague/html-to-markdown)
  9 | [![Total Downloads](https://img.shields.io/packagist/dt/league/html-to-markdown.svg?style=flat-square)](https://packagist.org/packages/league/html-to-markdown)
 10 | 
 11 | Library which converts HTML to [Markdown](http://daringfireball.net/projects/markdown/) for your sanity and convenience.
 12 | 
 13 | 
 14 | **Requires**: PHP 7.2+
 15 | 
 16 | **Lead Developer**: [@colinodell](http://twitter.com/colinodell)
 17 | 
 18 | **Original Author**: [@nickcernis](http://twitter.com/nickcernis)
 19 | 
 20 | 
 21 | ### Why convert HTML to Markdown?
 22 | 
 23 | *"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?"*
 24 | 
 25 | Typically you would convert HTML to Markdown if:
 26 | 
 27 | 1. You have an existing HTML document that needs to be edited by people with good taste.
 28 | 2. You want to store new content in HTML format but edit it as Markdown.
 29 | 3. You want to convert HTML email to plain text email.
 30 | 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.
 31 | 5. You just really like Markdown.
 32 | 
 33 | ### How to use it
 34 | 
 35 | Require the library by issuing this command:
 36 | 
 37 | ```bash
 38 | composer require league/html-to-markdown
 39 | ```
 40 | 
 41 | Add `require 'vendor/autoload.php';` to the top of your script.
 42 | 
 43 | Next, create a new HtmlConverter instance, passing in your valid HTML code to its `convert()` function:
 44 | 
 45 | ```php
 46 | use League\HTMLToMarkdown\HtmlConverter;
 47 | 
 48 | $converter = new HtmlConverter();
 49 | 
 50 | $html = "<h3>Quick, to the Batpoles!</h3>";
 51 | $markdown = $converter->convert($html);
 52 | ```
 53 | 
 54 | The `$markdown` variable now contains the Markdown version of your HTML as a string:
 55 | 
 56 | ```php
 57 | echo $markdown; // ==> ### Quick, to the Batpoles!
 58 | ```
 59 | 
 60 | The included `demo` directory contains an HTML->Markdown conversion form to try out.
 61 | 
 62 | ### Conversion options
 63 | 
 64 | > [!CAUTION]  
 65 | > By default, this library preserves HTML tags without Markdown equivalents, like `<span>`, `<div>`, `<iframe>`, `<script>`, etc. If you will be parsing untrusted input from users, **please consider setting the `strip_tags` and/or `remove_nodes` options** documented below, and also using a library (like [HTML Purifier](https://github.com/ezyang/htmlpurifier)) to provide additional HTML filtering.
 66 | 
 67 | To strip HTML tags that don't have a Markdown equivalent while preserving the content inside them, set `strip_tags` to true, like this:
 68 | 
 69 | ```php
 70 | $converter = new HtmlConverter(array('strip_tags' => true));
 71 | 
 72 | $html = '<span>Turnips!</span>';
 73 | $markdown = $converter->convert($html); // $markdown now contains "Turnips!"
 74 | ```
 75 | 
 76 | Or more explicitly, like this:
 77 | 
 78 | ```php
 79 | $converter = new HtmlConverter();
 80 | $converter->getConfig()->setOption('strip_tags', true);
 81 | 
 82 | $html = '<span>Turnips!</span>';
 83 | $markdown = $converter->convert($html); // $markdown now contains "Turnips!"
 84 | ```
 85 | 
 86 | Note that only the tags themselves are stripped, not the content they hold.
 87 | 
 88 | To strip tags and their content, pass a space-separated list of tags in `remove_nodes`, like this:
 89 | 
 90 | ```php
 91 | $converter = new HtmlConverter(array('remove_nodes' => 'span div'));
 92 | 
 93 | $html = '<span>Turnips!</span><div>Monkeys!</div>';
 94 | $markdown = $converter->convert($html); // $markdown now contains ""
 95 | ```
 96 | 
 97 | By default, all comments are stripped from the content. To preserve them, use the `preserve_comments` option, like this:
 98 | 
 99 | ```php
100 | $converter = new HtmlConverter(array('preserve_comments' => true));
101 | 
102 | $html = '<span>Turnips!</span><!-- Monkeys! -->';
103 | $markdown = $converter->convert($html); // $markdown now contains "Turnips!<!-- Monkeys! -->"
104 | ```
105 | 
106 | To preserve only specific comments, set `preserve_comments` with an array of strings, like this:
107 | 
108 | ```php
109 | $converter = new HtmlConverter(array('preserve_comments' => array('Eggs!')));
110 | 
111 | $html = '<span>Turnips!</span><!-- Monkeys! --><!-- Eggs! -->';
112 | $markdown = $converter->convert($html); // $markdown now contains "Turnips!<!-- Eggs! -->"
113 | ```
114 | 
115 | By default, placeholder links are preserved. To strip the placeholder links, use the `strip_placeholder_links` option, like this:
116 | 
117 | ```php
118 | $converter = new HtmlConverter(array('strip_placeholder_links' => true));
119 | 
120 | $html = '<a>Github</a>';
121 | $markdown = $converter->convert($html); // $markdown now contains "Github"
122 | ```
123 | 
124 | ### Style options
125 | 
126 | 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.
127 | 
128 | ```php
129 | $converter = new HtmlConverter();
130 | $converter->getConfig()->setOption('italic_style', '*');
131 | $converter->getConfig()->setOption('bold_style', '__');
132 | 
133 | $html = '<em>Italic</em> and a <strong>bold</strong>';
134 | $markdown = $converter->convert($html); // $markdown now contains "*Italic* and a __bold__"
135 | ```
136 | 
137 | ### Line break options
138 | 
139 | 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).
140 | 
141 | ```php
142 | $converter = new HtmlConverter();
143 | $html = '<p>test<br>line break</p>';
144 | 
145 | $converter->getConfig()->setOption('hard_break', true);
146 | $markdown = $converter->convert($html); // $markdown now contains "test\nline break"
147 | 
148 | $converter->getConfig()->setOption('hard_break', false); // default
149 | $markdown = $converter->convert($html); // $markdown now contains "test  \nline break"
150 | ```
151 | 
152 | ### Autolinking options
153 | 
154 | By default, `a` tags are converted to the easiest possible link syntax, i.e. if no text or title is available, then the `<url>` syntax will be used rather than the full `[url](url)` syntax. Set `use_autolinks` to `false` to change this behavior to always use the full link syntax.
155 | 
156 | ```php
157 | $converter = new HtmlConverter();
158 | $html = '<p><a href="https://thephpleague.com">https://thephpleague.com</a></p>';
159 | 
160 | $converter->getConfig()->setOption('use_autolinks', true);
161 | $markdown = $converter->convert($html); // $markdown now contains "<https://thephpleague.com>"
162 | 
163 | $converter->getConfig()->setOption('use_autolinks', false); // default
164 | $markdown = $converter->convert($html); // $markdown now contains "[https://thephpleague.com](https://thephpleague.com)"
165 | ```
166 | 
167 | ### Passing custom Environment object
168 | 
169 | You can pass current `Environment` object to customize i.e. which converters should be used.
170 | 
171 | ```php
172 | $environment = new Environment(array(
173 |     // your configuration here
174 | ));
175 | $environment->addConverter(new HeaderConverter()); // optionally - add converter manually
176 | 
177 | $converter = new HtmlConverter($environment);
178 | 
179 | $html = '<h3>Header</h3>
180 | <img src="" />
181 | ';
182 | $markdown = $converter->convert($html); // $markdown now contains "### Header" and "<img src="" />"
183 | ```
184 | 
185 | ### Table support
186 | 
187 | Support for Markdown tables is not enabled by default because it is not part of the original Markdown syntax. To use tables add the converter explicitly:
188 | 
189 | ```php
190 | use League\HTMLToMarkdown\HtmlConverter;
191 | use League\HTMLToMarkdown\Converter\TableConverter;
192 | 
193 | $converter = new HtmlConverter();
194 | $converter->getEnvironment()->addConverter(new TableConverter());
195 | 
196 | $html = "<table><tr><th>A</th></tr><tr><td>a</td></tr></table>";
197 | $markdown = $converter->convert($html);
198 | ```
199 | 
200 | ### Limitations
201 | 
202 | - Markdown Extra, MultiMarkdown and other variants aren't supported – just Markdown.
203 | 
204 | ### Style notes
205 | 
206 | - 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:
207 | 
208 |     `$converter = new HtmlConverter(array('header_style'=>'atx'));`
209 | 
210 |      Headers of H3 priority and lower always use atx style.
211 | 
212 | - Links and images are referenced inline. Footnote references (where image src and anchor href attributes are listed in the footnotes) are not used.
213 | - Blockquotes aren't line wrapped – it makes the converted Markdown easier to edit.
214 | 
215 | ### Dependencies
216 | 
217 | 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.
218 | 
219 | 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.
220 | 
221 | ### Contributors
222 | 
223 | Many thanks to all [contributors](https://github.com/thephpleague/html-to-markdown/graphs/contributors) so far. Further improvements and feature suggestions are very welcome.
224 | 
225 | ### How it works
226 | 
227 | 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.
228 | 
229 | ### To-do
230 | 
231 | - Support for nested lists and lists inside blockquotes.
232 | - Offer an option to preserve tags as HTML if they contain attributes that can't be represented with Markdown (e.g. `style`).
233 | 
234 | ### Trying to convert Markdown to HTML?
235 | 
236 | Use one of these great libraries:
237 | 
238 |  - [league/commonmark](https://github.com/thephpleague/commonmark) (recommended)
239 |  - [cebe/markdown](https://github.com/cebe/markdown)
240 |  - [PHP Markdown](https://michelf.ca/projects/php-markdown/)
241 |  - [Parsedown](https://github.com/erusev/parsedown)
242 | 
243 | No guarantees about the Elvish, though.
244 | 


--------------------------------------------------------------------------------
/bin/html-to-markdown:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env php
  2 | <?php
  3 | 
  4 | requireAutoloader();
  5 | 
  6 | ini_set('display_errors', 'stderr');
  7 | 
  8 | foreach ($argv as $i => $arg) {
  9 |     if ($i === 0) {
 10 |         continue;
 11 |     }
 12 | 
 13 |     if (substr($arg, 0, 1) === '-') {
 14 |         switch ($arg) {
 15 |             case '-h':
 16 |             case '--help':
 17 |                 echo getHelpText();
 18 |                 exit(0);
 19 |             default:
 20 |                 fail('Unknown option: ' . $arg);
 21 |         }
 22 |     } else {
 23 |         $src = $argv[1];
 24 |     }
 25 | }
 26 | 
 27 | if (isset($src)) {
 28 |     if (!file_exists($src)) {
 29 |         fail('File not found: ' . $src);
 30 |     }
 31 | 
 32 |     $html = file_get_contents($src);
 33 | } else {
 34 |     $stdin = fopen('php://stdin', 'r');
 35 |     stream_set_blocking($stdin, false);
 36 |     $html = stream_get_contents($stdin);
 37 |     fclose($stdin);
 38 | 
 39 |     if (empty($html)) {
 40 |         fail(getHelpText());
 41 |     }
 42 | }
 43 | 
 44 | 
 45 | $converter = new League\HTMLToMarkdown\HtmlConverter();
 46 | echo $converter->convert($html);
 47 | 
 48 | /**
 49 |  * Get help and usage info
 50 |  *
 51 |  * @return string
 52 |  */
 53 | function getHelpText()
 54 | {
 55 |     return <<<HELP
 56 | HTML To Markdown
 57 | 
 58 | Usage: html-to-markdown [OPTIONS] [FILE]
 59 | 
 60 |     -h, --help  Shows help and usage information
 61 | 
 62 |     If no file is given, input will be read from STDIN
 63 | 
 64 | Examples:
 65 | 
 66 |     Converting a file named document.html:
 67 | 
 68 |         html-to-markdown document.html
 69 | 
 70 |     Converting a file and saving its output:
 71 | 
 72 |         html-to-markdown document.html > output.md
 73 | 
 74 |     Converting from STDIN:
 75 | 
 76 |         echo -e '<h1>Hello World!</h1>' | html-to-markdown
 77 | 
 78 |     Converting from STDIN and saving the output:
 79 | 
 80 |         echo -e '<h1>Hello World!</h1>' | html-to-markdown > output.md
 81 | 
 82 | HELP;
 83 | }
 84 | 
 85 | /**
 86 |  * @param string $message Error message
 87 |  */
 88 | function fail($message)
 89 | {
 90 |     fwrite(STDERR, $message . "\n");
 91 |     exit(1);
 92 | }
 93 | 
 94 | function requireAutoloader()
 95 | {
 96 |     $autoloadPaths = array(
 97 |         // Local package usage
 98 |         __DIR__ . '/../vendor/autoload.php',
 99 |         // Package was included as a library
100 |         __DIR__ . '/../../../autoload.php',
101 |     );
102 |     foreach ($autoloadPaths as $path) {
103 |         if (file_exists($path)) {
104 |             require_once $path;
105 |             break;
106 |         }
107 |     }
108 | }
109 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "league/html-to-markdown",
 3 |     "type": "library",
 4 |     "description": "An HTML-to-markdown conversion helper for PHP",
 5 |     "keywords": ["markdown", "html"],
 6 |     "homepage": "https://github.com/thephpleague/html-to-markdown",
 7 |     "license": "MIT",
 8 |     "authors": [
 9 |         {
10 |             "name": "Colin O'Dell",
11 |             "email": "colinodell@gmail.com",
12 |             "homepage": "https://www.colinodell.com",
13 |             "role": "Lead Developer"
14 |         },
15 |         {
16 |             "name": "Nick Cernis",
17 |             "email": "nick@cern.is",
18 |             "homepage": "http://modernnerd.net",
19 |             "role": "Original Author"
20 |         }
21 |     ],
22 |     "autoload": {
23 |         "psr-4": {
24 |             "League\\HTMLToMarkdown\\": "src/"
25 |         }
26 |     },
27 |     "autoload-dev": {
28 |         "psr-4": {
29 |             "League\\HTMLToMarkdown\\Test\\": "tests"
30 |         }
31 |     },
32 |     "require": {
33 |         "php": "^7.2.5 || ^8.0",
34 |         "ext-dom": "*",
35 |         "ext-xml": "*"
36 |     },
37 |     "require-dev": {
38 |         "mikehaertl/php-shellcommand": "^1.1.0",
39 |         "phpstan/phpstan": "^1.8.8",
40 |         "phpunit/phpunit": "^8.5 || ^9.2",
41 |         "scrutinizer/ocular": "^1.6",
42 |         "unleashedtech/php-coding-standard": "^2.7 || ^3.0",
43 |         "vimeo/psalm": "^4.22 || ^5.0"
44 |     },
45 |     "bin": ["bin/html-to-markdown"],
46 |     "scripts": {
47 |         "phpcs": "phpcs",
48 |         "phpstan": "phpstan analyse",
49 |         "phpunit": "phpunit --no-coverage",
50 |         "psalm": "psalm --stats",
51 |         "test": [
52 |             "@phpcs",
53 |             "@phpstan",
54 |             "@psalm",
55 |             "@phpunit"
56 |         ]
57 |     },
58 |     "extra": {
59 |         "branch-alias": {
60 |             "dev-master": "5.2-dev"
61 |         }
62 |     },
63 |     "config": {
64 |         "allow-plugins": {
65 |             "dealerdirect/phpcodesniffer-composer-installer": true
66 |         }
67 |     }
68 | }
69 | 


--------------------------------------------------------------------------------
/phpcs.xml.dist:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <ruleset>
 3 |     <arg name="basepath" value="."/>
 4 |     <arg name="extensions" value="php"/>
 5 |     <arg name="parallel" value="80"/>
 6 |     <arg name="cache" value=".phpcs-cache"/>
 7 |     <arg name="colors"/>
 8 | 
 9 |     <!-- Ignore warnings, show progress of the run and show sniff names -->
10 |     <arg value="nps"/>
11 | 
12 |     <!-- Directories to be checked -->
13 |     <file>src</file>
14 |     <file>tests</file>
15 | 
16 |     <!-- Include full Unleashed Coding Standard -->
17 |     <rule ref="Unleashed"/>
18 | 
19 |     <rule ref="SlevomatCodingStandard.Commenting.ForbiddenAnnotations.AnnotationForbidden">
20 |         <exclude-pattern>src/HtmlConverter*\.php</exclude-pattern>
21 |     </rule>
22 | 
23 |     <rule ref="SlevomatCodingStandard.Commenting.DocCommentSpacing.IncorrectOrderOfAnnotationsGroup">
24 |         <exclude-pattern>src/HtmlConverter*\.php</exclude-pattern>
25 |     </rule>
26 | 
27 | </ruleset>
28 | 


--------------------------------------------------------------------------------
/phpstan.neon.dist:
--------------------------------------------------------------------------------
1 | parameters:
2 |   level: max
3 |   paths:
4 |     - src
5 | 


--------------------------------------------------------------------------------
/psalm.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <psalm
 3 |     errorLevel="3"
 4 |     resolveFromConfigFile="true"
 5 |     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 6 |     xmlns="https://getpsalm.org/schema/config"
 7 |     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
 8 | >
 9 |     <projectFiles>
10 |         <directory name="src" />
11 |         <ignoreFiles>
12 |             <directory name="vendor" />
13 |         </ignoreFiles>
14 |     </projectFiles>
15 | </psalm>
16 | 


--------------------------------------------------------------------------------
/src/Coerce.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown;
 6 | 
 7 | /**
 8 |  * @internal
 9 |  */
10 | final class Coerce
11 | {
12 |     private function __construct()
13 |     {
14 |     }
15 | 
16 |     /**
17 |      * @param mixed $val
18 |      */
19 |     public static function toString($val): string
20 |     {
21 |         switch (true) {
22 |             case \is_string($val):
23 |                 return $val;
24 |             case \is_bool($val):
25 |             case \is_float($val):
26 |             case \is_int($val):
27 |             case $val === null:
28 |                 return \strval($val);
29 |             case \is_object($val) && \method_exists($val, '__toString'):
30 |                 return $val->__toString();
31 |             default:
32 |                 throw new \InvalidArgumentException('Cannot coerce this value to string');
33 |         }
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/src/Configuration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown;
 6 | 
 7 | class Configuration
 8 | {
 9 |     /** @var array<string, mixed> */
10 |     protected $config;
11 | 
12 |     /**
13 |      * @param array<string, mixed> $config
14 |      */
15 |     public function __construct(array $config = [])
16 |     {
17 |         $this->config = $config;
18 | 
19 |         $this->checkForDeprecatedOptions($config);
20 |     }
21 | 
22 |     /**
23 |      * @param array<string, mixed> $config
24 |      */
25 |     public function merge(array $config = []): void
26 |     {
27 |         $this->checkForDeprecatedOptions($config);
28 |         $this->config = \array_replace_recursive($this->config, $config);
29 |     }
30 | 
31 |     /**
32 |      * @param array<string, mixed> $config
33 |      */
34 |     public function replace(array $config = []): void
35 |     {
36 |         $this->checkForDeprecatedOptions($config);
37 |         $this->config = $config;
38 |     }
39 | 
40 |     /**
41 |      * @param mixed $value
42 |      */
43 |     public function setOption(string $key, $value): void
44 |     {
45 |         $this->checkForDeprecatedOptions([$key => $value]);
46 |         $this->config[$key] = $value;
47 |     }
48 | 
49 |     /**
50 |      * @param mixed|null $default
51 |      *
52 |      * @return mixed|null
53 |      */
54 |     public function getOption(?string $key = null, $default = null)
55 |     {
56 |         if ($key === null) {
57 |             return $this->config;
58 |         }
59 | 
60 |         if (! isset($this->config[$key])) {
61 |             return $default;
62 |         }
63 | 
64 |         return $this->config[$key];
65 |     }
66 | 
67 |     /**
68 |      * @param array<string, mixed> $config
69 |      */
70 |     private function checkForDeprecatedOptions(array $config): void
71 |     {
72 |         foreach ($config as $key => $value) {
73 |             if ($key === 'bold_style' && $value !== '**') {
74 |                 @\trigger_error('Customizing the bold_style option is deprecated and may be removed in the next major version', E_USER_DEPRECATED);
75 |             } elseif ($key === 'italic_style' && $value !== '*') {
76 |                 @\trigger_error('Customizing the italic_style option is deprecated and may be removed in the next major version', E_USER_DEPRECATED);
77 |             }
78 |         }
79 |     }
80 | }
81 | 


--------------------------------------------------------------------------------
/src/ConfigurationAwareInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown;
 6 | 
 7 | interface ConfigurationAwareInterface
 8 | {
 9 |     public function setConfig(Configuration $config): void;
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Converter/BlockquoteConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\ElementInterface;
 8 | 
 9 | class BlockquoteConverter implements ConverterInterface
10 | {
11 |     public function convert(ElementInterface $element): string
12 |     {
13 |         // Contents should have already been converted to Markdown by this point,
14 |         // so we just need to add '>' symbols to each line.
15 | 
16 |         $markdown = '';
17 | 
18 |         $quoteContent = \trim($element->getValue());
19 | 
20 |         $lines = \preg_split('/\r\n|\r|\n/', $quoteContent);
21 |         \assert(\is_array($lines));
22 | 
23 |         $totalLines = \count($lines);
24 | 
25 |         foreach ($lines as $i => $line) {
26 |             $markdown .= '> ' . $line . "\n";
27 |             if ($i + 1 === $totalLines) {
28 |                 $markdown .= "\n";
29 |             }
30 |         }
31 | 
32 |         return $markdown;
33 |     }
34 | 
35 |     /**
36 |      * @return string[]
37 |      */
38 |     public function getSupportedTags(): array
39 |     {
40 |         return ['blockquote'];
41 |     }
42 | }
43 | 


--------------------------------------------------------------------------------
/src/Converter/CodeConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\ElementInterface;
 8 | 
 9 | class CodeConverter implements ConverterInterface
10 | {
11 |     public function convert(ElementInterface $element): string
12 |     {
13 |         $language = '';
14 | 
15 |         // Checking for language class on the code block
16 |         $classes = $element->getAttribute('class');
17 | 
18 |         if ($classes) {
19 |             // Since tags can have more than one class, we need to find the one that starts with 'language-'
20 |             $classes = \explode(' ', $classes);
21 |             foreach ($classes as $class) {
22 |                 if (\strpos($class, 'language-') !== false) {
23 |                     // Found one, save it as the selected language and stop looping over the classes.
24 |                     $language = \str_replace('language-', '', $class);
25 |                     break;
26 |                 }
27 |             }
28 |         }
29 | 
30 |         $markdown = '';
31 |         $code     = \html_entity_decode($element->getChildrenAsString());
32 | 
33 |         // In order to remove the code tags we need to search for them and, in the case of the opening tag
34 |         // use a regular expression to find the tag and the other attributes it might have
35 |         $code = \preg_replace('/<code\b[^>]*>/', '', $code);
36 |         \assert($code !== null);
37 |         $code = \str_replace('</code>', '', $code);
38 | 
39 |         // Checking if it's a code block or span
40 |         if ($this->shouldBeBlock($element, $code)) {
41 |             // Code block detected, newlines will be added in parent
42 |             $markdown .= '```' . $language . "\n" . $code . "\n" . '```';
43 |         } else {
44 |             // One line of code, wrapping it on one backtick, removing new lines
45 |             $markdown .= '`' . \preg_replace('/\r\n|\r|\n/', '', $code) . '`';
46 |         }
47 | 
48 |         return $markdown;
49 |     }
50 | 
51 |     /**
52 |      * @return string[]
53 |      */
54 |     public function getSupportedTags(): array
55 |     {
56 |         return ['code'];
57 |     }
58 | 
59 |     private function shouldBeBlock(ElementInterface $element, string $code): bool
60 |     {
61 |         $parent = $element->getParent();
62 |         if ($parent !== null && $parent->getTagName() === 'pre') {
63 |             return true;
64 |         }
65 | 
66 |         return \preg_match('/[^\s]` `/', $code) === 1;
67 |     }
68 | }
69 | 


--------------------------------------------------------------------------------
/src/Converter/CommentConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\Configuration;
 8 | use League\HTMLToMarkdown\ConfigurationAwareInterface;
 9 | use League\HTMLToMarkdown\ElementInterface;
10 | 
11 | class CommentConverter implements ConverterInterface, ConfigurationAwareInterface
12 | {
13 |     /** @var Configuration */
14 |     protected $config;
15 | 
16 |     public function setConfig(Configuration $config): void
17 |     {
18 |         $this->config = $config;
19 |     }
20 | 
21 |     public function convert(ElementInterface $element): string
22 |     {
23 |         if ($this->shouldPreserve($element)) {
24 |             return '<!--' . $element->getValue() . '-->';
25 |         }
26 | 
27 |         return '';
28 |     }
29 | 
30 |     /**
31 |      * @return string[]
32 |      */
33 |     public function getSupportedTags(): array
34 |     {
35 |         return ['#comment'];
36 |     }
37 | 
38 |     private function shouldPreserve(ElementInterface $element): bool
39 |     {
40 |         $preserve = $this->config->getOption('preserve_comments');
41 |         if ($preserve === true) {
42 |             return true;
43 |         }
44 | 
45 |         if (\is_array($preserve)) {
46 |             $value = \trim($element->getValue());
47 | 
48 |             return \in_array($value, $preserve, true);
49 |         }
50 | 
51 |         return false;
52 |     }
53 | }
54 | 


--------------------------------------------------------------------------------
/src/Converter/ConverterInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\ElementInterface;
 8 | 
 9 | interface ConverterInterface
10 | {
11 |     public function convert(ElementInterface $element): string;
12 | 
13 |     /**
14 |      * @return string[]
15 |      */
16 |     public function getSupportedTags(): array;
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Converter/DefaultConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\Configuration;
 8 | use League\HTMLToMarkdown\ConfigurationAwareInterface;
 9 | use League\HTMLToMarkdown\ElementInterface;
10 | 
11 | class DefaultConverter implements ConverterInterface, ConfigurationAwareInterface
12 | {
13 |     public const DEFAULT_CONVERTER = '_default';
14 | 
15 |     /** @var Configuration */
16 |     protected $config;
17 | 
18 |     public function setConfig(Configuration $config): void
19 |     {
20 |         $this->config = $config;
21 |     }
22 | 
23 |     public function convert(ElementInterface $element): string
24 |     {
25 |         // If strip_tags is false (the default), preserve tags that don't have Markdown equivalents,
26 |         // such as <span> nodes on their own. C14N() canonicalizes the node to a string.
27 |         // See: http://www.php.net/manual/en/domnode.c14n.php
28 |         if ($this->config->getOption('strip_tags', false)) {
29 |             return $element->getValue();
30 |         }
31 | 
32 |         $markdown = \html_entity_decode($element->getChildrenAsString());
33 | 
34 |         // Tables are only handled here if TableConverter is not used
35 |         if ($element->getTagName() === 'table') {
36 |             $markdown .= "\n\n";
37 |         }
38 | 
39 |         return $markdown;
40 |     }
41 | 
42 |     /**
43 |      * @return string[]
44 |      */
45 |     public function getSupportedTags(): array
46 |     {
47 |         return [self::DEFAULT_CONVERTER];
48 |     }
49 | }
50 | 


--------------------------------------------------------------------------------
/src/Converter/DivConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\Configuration;
 8 | use League\HTMLToMarkdown\ConfigurationAwareInterface;
 9 | use League\HTMLToMarkdown\ElementInterface;
10 | 
11 | class DivConverter implements ConverterInterface, ConfigurationAwareInterface
12 | {
13 |     /** @var Configuration */
14 |     protected $config;
15 | 
16 |     public function setConfig(Configuration $config): void
17 |     {
18 |         $this->config = $config;
19 |     }
20 | 
21 |     public function convert(ElementInterface $element): string
22 |     {
23 |         if ($this->config->getOption('strip_tags', false)) {
24 |             return $element->getValue() . "\n\n";
25 |         }
26 | 
27 |         return \html_entity_decode($element->getChildrenAsString());
28 |     }
29 | 
30 |     /**
31 |      * @return string[]
32 |      */
33 |     public function getSupportedTags(): array
34 |     {
35 |         return ['div'];
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/src/Converter/EmphasisConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\Configuration;
 8 | use League\HTMLToMarkdown\ConfigurationAwareInterface;
 9 | use League\HTMLToMarkdown\ElementInterface;
10 | 
11 | class EmphasisConverter implements ConverterInterface, ConfigurationAwareInterface
12 | {
13 |     /** @var Configuration */
14 |     protected $config;
15 | 
16 |     protected function getNormTag(?ElementInterface $element): string
17 |     {
18 |         if ($element !== null && ! $element->isText()) {
19 |             $tag = $element->getTagName();
20 |             if ($tag === 'i' || $tag === 'em') {
21 |                 return 'em';
22 |             }
23 | 
24 |             if ($tag === 'b' || $tag === 'strong') {
25 |                 return 'strong';
26 |             }
27 |         }
28 | 
29 |         return '';
30 |     }
31 | 
32 |     public function setConfig(Configuration $config): void
33 |     {
34 |         $this->config = $config;
35 |     }
36 | 
37 |     public function convert(ElementInterface $element): string
38 |     {
39 |         $tag   = $this->getNormTag($element);
40 |         $value = $element->getValue();
41 | 
42 |         if (! \trim($value)) {
43 |             return $value;
44 |         }
45 | 
46 |         if ($tag === 'em') {
47 |             $style = $this->config->getOption('italic_style');
48 |         } else {
49 |             $style = $this->config->getOption('bold_style');
50 |         }
51 | 
52 |         $prefix = \ltrim($value) !== $value ? ' ' : '';
53 |         $suffix = \rtrim($value) !== $value ? ' ' : '';
54 | 
55 |         /* If this node is immediately preceded or followed by one of the same type don't emit
56 |          * the start or end $style, respectively. This prevents <em>foo</em><em>bar</em> from
57 |          * being converted to *foo**bar* which is incorrect. We want *foobar* instead.
58 |          */
59 |         $preStyle  = $this->getNormTag($element->getPreviousSibling()) === $tag ? '' : $style;
60 |         $postStyle = $this->getNormTag($element->getNextSibling()) === $tag ? '' : $style;
61 | 
62 |         return $prefix . $preStyle . \trim($value) . $postStyle . $suffix;
63 |     }
64 | 
65 |     /**
66 |      * @return string[]
67 |      */
68 |     public function getSupportedTags(): array
69 |     {
70 |         return ['em', 'i', 'strong', 'b'];
71 |     }
72 | }
73 | 


--------------------------------------------------------------------------------
/src/Converter/HardBreakConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\Configuration;
 8 | use League\HTMLToMarkdown\ConfigurationAwareInterface;
 9 | use League\HTMLToMarkdown\ElementInterface;
10 | 
11 | class HardBreakConverter implements ConverterInterface, ConfigurationAwareInterface
12 | {
13 |     /** @var Configuration */
14 |     protected $config;
15 | 
16 |     public function setConfig(Configuration $config): void
17 |     {
18 |         $this->config = $config;
19 |     }
20 | 
21 |     public function convert(ElementInterface $element): string
22 |     {
23 |         $return = $this->config->getOption('hard_break') ? "\n" : "  \n";
24 | 
25 |         $next = $element->getNext();
26 |         if ($next) {
27 |             $nextValue = $next->getValue();
28 |             if ($nextValue) {
29 |                 if (\in_array(\substr($nextValue, 0, 2), ['- ', '* ', '+ '], true)) {
30 |                     $parent = $element->getParent();
31 |                     if ($parent && $parent->getTagName() === 'li') {
32 |                         $return .= '\\';
33 |                     }
34 |                 }
35 |             }
36 |         }
37 | 
38 |         return $return;
39 |     }
40 | 
41 |     /**
42 |      * @return string[]
43 |      */
44 |     public function getSupportedTags(): array
45 |     {
46 |         return ['br'];
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/src/Converter/HeaderConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\Configuration;
 8 | use League\HTMLToMarkdown\ConfigurationAwareInterface;
 9 | use League\HTMLToMarkdown\ElementInterface;
10 | 
11 | class HeaderConverter implements ConverterInterface, ConfigurationAwareInterface
12 | {
13 |     public const STYLE_ATX    = 'atx';
14 |     public const STYLE_SETEXT = 'setext';
15 | 
16 |     /** @var Configuration */
17 |     protected $config;
18 | 
19 |     public function setConfig(Configuration $config): void
20 |     {
21 |         $this->config = $config;
22 |     }
23 | 
24 |     public function convert(ElementInterface $element): string
25 |     {
26 |         $level = (int) \substr($element->getTagName(), 1, 1);
27 |         $style = $this->config->getOption('header_style', self::STYLE_SETEXT);
28 | 
29 |         if (\strlen($element->getValue()) === 0) {
30 |             return "\n";
31 |         }
32 | 
33 |         if (($level === 1 || $level === 2) && ! $element->isDescendantOf('blockquote') && $style === self::STYLE_SETEXT) {
34 |             return $this->createSetextHeader($level, $element->getValue());
35 |         }
36 | 
37 |         return $this->createAtxHeader($level, $element->getValue());
38 |     }
39 | 
40 |     /**
41 |      * @return string[]
42 |      */
43 |     public function getSupportedTags(): array
44 |     {
45 |         return ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
46 |     }
47 | 
48 |     private function createSetextHeader(int $level, string $content): string
49 |     {
50 |         $length    = \function_exists('mb_strlen') ? \mb_strlen($content, 'utf-8') : \strlen($content);
51 |         $underline = $level === 1 ? '=' : '-';
52 | 
53 |         return $content . "\n" . \str_repeat($underline, $length) . "\n\n";
54 |     }
55 | 
56 |     private function createAtxHeader(int $level, string $content): string
57 |     {
58 |         $prefix = \str_repeat('#', $level) . ' ';
59 | 
60 |         return $prefix . $content . "\n\n";
61 |     }
62 | }
63 | 


--------------------------------------------------------------------------------
/src/Converter/HorizontalRuleConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\ElementInterface;
 8 | 
 9 | class HorizontalRuleConverter implements ConverterInterface
10 | {
11 |     public function convert(ElementInterface $element): string
12 |     {
13 |         return "---\n\n";
14 |     }
15 | 
16 |     /**
17 |      * @return string[]
18 |      */
19 |     public function getSupportedTags(): array
20 |     {
21 |         return ['hr'];
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Converter/ImageConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\ElementInterface;
 8 | 
 9 | class ImageConverter implements ConverterInterface
10 | {
11 |     public function convert(ElementInterface $element): string
12 |     {
13 |         $src   = $element->getAttribute('src');
14 |         $alt   = $element->getAttribute('alt');
15 |         $title = $element->getAttribute('title');
16 | 
17 |         if ($title !== '') {
18 |             // No newlines added. <img> should be in a block-level element.
19 |             return '![' . $alt . '](' . $src . ' "' . $title . '")';
20 |         }
21 | 
22 |         return '![' . $alt . '](' . $src . ')';
23 |     }
24 | 
25 |     /**
26 |      * @return string[]
27 |      */
28 |     public function getSupportedTags(): array
29 |     {
30 |         return ['img'];
31 |     }
32 | }
33 | 


--------------------------------------------------------------------------------
/src/Converter/LinkConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\Configuration;
 8 | use League\HTMLToMarkdown\ConfigurationAwareInterface;
 9 | use League\HTMLToMarkdown\ElementInterface;
10 | 
11 | class LinkConverter implements ConverterInterface, ConfigurationAwareInterface
12 | {
13 |     /** @var Configuration */
14 |     protected $config;
15 | 
16 |     public function setConfig(Configuration $config): void
17 |     {
18 |         $this->config = $config;
19 |     }
20 | 
21 |     public function convert(ElementInterface $element): string
22 |     {
23 |         $href  = $element->getAttribute('href');
24 |         $title = $element->getAttribute('title');
25 |         $text  = \trim($element->getValue(), "\t\n\r\0\x0B");
26 | 
27 |         if ($title !== '') {
28 |             $markdown = '[' . $text . '](' . $href . ' "' . $title . '")';
29 |         } elseif ($href === $text && $this->isValidAutolink($href)) {
30 |             $markdown = '<' . $href . '>';
31 |         } elseif ($href === 'mailto:' . $text && $this->isValidEmail($text)) {
32 |             $markdown = '<' . $text . '>';
33 |         } else {
34 |             if (\stristr($href, ' ')) {
35 |                 $href = '<' . $href . '>';
36 |             }
37 | 
38 |             $markdown = '[' . $text . '](' . $href . ')';
39 |         }
40 | 
41 |         if (! $href) {
42 |             if ($this->shouldStrip()) {
43 |                 $markdown = $text;
44 |             } else {
45 |                 $markdown = \html_entity_decode($element->getChildrenAsString());
46 |             }
47 |         }
48 | 
49 |         return $markdown;
50 |     }
51 | 
52 |     /**
53 |      * @return string[]
54 |      */
55 |     public function getSupportedTags(): array
56 |     {
57 |         return ['a'];
58 |     }
59 | 
60 |     private function isValidAutolink(string $href): bool
61 |     {
62 |         $useAutolinks = $this->config->getOption('use_autolinks');
63 | 
64 |         return $useAutolinks && (\preg_match('/^[A-Za-z][A-Za-z0-9.+-]{1,31}:[^<>\x00-\x20]*/i', $href) === 1);
65 |     }
66 | 
67 |     private function isValidEmail(string $email): bool
68 |     {
69 |         // Email validation is messy business, but this should cover most cases
70 |         return \filter_var($email, FILTER_VALIDATE_EMAIL) !== false;
71 |     }
72 | 
73 |     private function shouldStrip(): bool
74 |     {
75 |         return \boolval($this->config->getOption('strip_placeholder_links') ?? false);
76 |     }
77 | }
78 | 


--------------------------------------------------------------------------------
/src/Converter/ListBlockConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\ElementInterface;
 8 | 
 9 | class ListBlockConverter implements ConverterInterface
10 | {
11 |     public function convert(ElementInterface $element): string
12 |     {
13 |         return $element->getValue() . "\n";
14 |     }
15 | 
16 |     /**
17 |      * @return string[]
18 |      */
19 |     public function getSupportedTags(): array
20 |     {
21 |         return ['ol', 'ul'];
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Converter/ListItemConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\Coerce;
 8 | use League\HTMLToMarkdown\Configuration;
 9 | use League\HTMLToMarkdown\ConfigurationAwareInterface;
10 | use League\HTMLToMarkdown\ElementInterface;
11 | 
12 | class ListItemConverter implements ConverterInterface, ConfigurationAwareInterface
13 | {
14 |     /** @var Configuration */
15 |     protected $config;
16 | 
17 |     /** @var string|null */
18 |     protected $listItemStyle;
19 | 
20 |     public function setConfig(Configuration $config): void
21 |     {
22 |         $this->config = $config;
23 |     }
24 | 
25 |     public function convert(ElementInterface $element): string
26 |     {
27 |         // If parent is an ol, use numbers, otherwise, use dashes
28 |         $listType = ($parent = $element->getParent()) ? $parent->getTagName() : 'ul';
29 | 
30 |         // Add spaces to start for nested list items
31 |         $level = $element->getListItemLevel();
32 | 
33 |         $value = \trim(\implode("\n" . '    ', \explode("\n", \trim($element->getValue()))));
34 | 
35 |         // If list item is the first in a nested list, add a newline before it
36 |         $prefix = '';
37 |         if ($level > 0 && $element->getSiblingPosition() === 1) {
38 |             $prefix = "\n";
39 |         }
40 | 
41 |         if ($listType === 'ul') {
42 |             $listItemStyle          = Coerce::toString($this->config->getOption('list_item_style', '-'));
43 |             $listItemStyleAlternate = Coerce::toString($this->config->getOption('list_item_style_alternate', ''));
44 |             if (! isset($this->listItemStyle)) {
45 |                 $this->listItemStyle = $listItemStyleAlternate ?: $listItemStyle;
46 |             }
47 | 
48 |             if ($listItemStyleAlternate && $level === 0 && $element->getSiblingPosition() === 1) {
49 |                 $this->listItemStyle = $this->listItemStyle === $listItemStyle ? $listItemStyleAlternate : $listItemStyle;
50 |             }
51 | 
52 |             return $prefix . $this->listItemStyle . ' ' . $value . "\n";
53 |         }
54 | 
55 |         if ($listType === 'ol' && ($parent = $element->getParent()) && ($start = \intval($parent->getAttribute('start')))) {
56 |             $number = $start + $element->getSiblingPosition() - 1;
57 |         } else {
58 |             $number = $element->getSiblingPosition();
59 |         }
60 | 
61 |         return $prefix . $number . '. ' . $value . "\n";
62 |     }
63 | 
64 |     /**
65 |      * @return string[]
66 |      */
67 |     public function getSupportedTags(): array
68 |     {
69 |         return ['li'];
70 |     }
71 | }
72 | 


--------------------------------------------------------------------------------
/src/Converter/ParagraphConverter.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | namespace League\HTMLToMarkdown\Converter;
  6 | 
  7 | use League\HTMLToMarkdown\ElementInterface;
  8 | 
  9 | class ParagraphConverter implements ConverterInterface
 10 | {
 11 |     public function convert(ElementInterface $element): string
 12 |     {
 13 |         $value = $element->getValue();
 14 | 
 15 |         $markdown = '';
 16 | 
 17 |         $lines = \preg_split('/\r\n|\r|\n/', $value);
 18 |         \assert($lines !== false);
 19 | 
 20 |         foreach ($lines as $line) {
 21 |             /*
 22 |              * Some special characters need to be escaped based on the position that they appear
 23 |              * The following function will deal with those special cases.
 24 |              */
 25 |             $markdown .= $this->escapeSpecialCharacters($line);
 26 |             $markdown .= "\n";
 27 |         }
 28 | 
 29 |         return \trim($markdown) !== '' ? \rtrim($markdown) . "\n\n" : '';
 30 |     }
 31 | 
 32 |     /**
 33 |      * @return string[]
 34 |      */
 35 |     public function getSupportedTags(): array
 36 |     {
 37 |         return ['p'];
 38 |     }
 39 | 
 40 |     private function escapeSpecialCharacters(string $line): string
 41 |     {
 42 |         $line = $this->escapeFirstCharacters($line);
 43 |         $line = $this->escapeOtherCharacters($line);
 44 |         $line = $this->escapeOtherCharactersRegex($line);
 45 | 
 46 |         return $line;
 47 |     }
 48 | 
 49 |     private function escapeFirstCharacters(string $line): string
 50 |     {
 51 |         $escapable = [
 52 |             '>',
 53 |             '- ',
 54 |             '+ ',
 55 |             '--',
 56 |             '~~~',
 57 |             '---',
 58 |             '- - -',
 59 |         ];
 60 | 
 61 |         foreach ($escapable as $i) {
 62 |             if (\strpos(\ltrim($line), $i) === 0) {
 63 |                 // Found a character that must be escaped, adding a backslash before
 64 |                 return '\\' . \ltrim($line);
 65 |             }
 66 |         }
 67 | 
 68 |         return $line;
 69 |     }
 70 | 
 71 |     private function escapeOtherCharacters(string $line): string
 72 |     {
 73 |         $escapable = [
 74 |             '<!--',
 75 |         ];
 76 | 
 77 |         foreach ($escapable as $i) {
 78 |             if (($pos = \strpos($line, $i)) === false) {
 79 |                 continue;
 80 |             }
 81 | 
 82 |             // Found an escapable character, escaping it
 83 |             $line = \substr_replace($line, '\\', $pos, 0);
 84 |         }
 85 | 
 86 |         return $line;
 87 |     }
 88 | 
 89 |     private function escapeOtherCharactersRegex(string $line): string
 90 |     {
 91 |         $regExs = [
 92 |             // Match numbers ending on ')' or '.' that are at the beginning of the line.
 93 |             // They will be escaped if immediately followed by a space or newline.
 94 |             '/^[0-9]+(?=(\)|\.)( |$))/',
 95 |         ];
 96 | 
 97 |         foreach ($regExs as $i) {
 98 |             if (! \preg_match($i, $line, $match)) {
 99 |                 continue;
100 |             }
101 | 
102 |             // Matched an escapable character, adding a backslash on the string before the offending character
103 |             $line = \substr_replace($line, '\\', \strlen($match[0]), 0);
104 |         }
105 | 
106 |         return $line;
107 |     }
108 | }
109 | 


--------------------------------------------------------------------------------
/src/Converter/PreformattedConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\ElementInterface;
 8 | 
 9 | class PreformattedConverter implements ConverterInterface
10 | {
11 |     public function convert(ElementInterface $element): string
12 |     {
13 |         $preContent = \html_entity_decode($element->getChildrenAsString());
14 |         $preContent = \preg_replace('/<pre\b[^>]*>/', '', $preContent);
15 |         \assert($preContent !== null);
16 |         $preContent = \str_replace('</pre>', '', $preContent);
17 | 
18 |         /*
19 |          * Checking for the code tag.
20 |          * Usually pre tags are used along with code tags. This conditional will check for already converted code tags,
21 |          * which use backticks, and if those backticks are at the beginning and at the end of the string it means
22 |          * there's no more information to convert.
23 |          */
24 | 
25 |         $firstBacktick = \strpos(\trim($preContent), '`');
26 |         $lastBacktick  = \strrpos(\trim($preContent), '`');
27 |         if ($firstBacktick === 0 && $lastBacktick === \strlen(\trim($preContent)) - 1) {
28 |             return $preContent . "\n\n";
29 |         }
30 | 
31 |         // If the execution reaches this point it means it's just a pre tag, with no code tag nested
32 | 
33 |         // Empty lines are a special case
34 |         if ($preContent === '') {
35 |             return "```\n```\n\n";
36 |         }
37 | 
38 |         // Normalizing new lines
39 |         $preContent = \preg_replace('/\r\n|\r|\n/', "\n", $preContent);
40 |         \assert(\is_string($preContent));
41 | 
42 |         // Ensure there's a newline at the end
43 |         if (\strrpos($preContent, "\n") !== \strlen($preContent) - \strlen("\n")) {
44 |             $preContent .= "\n";
45 |         }
46 | 
47 |         // Use three backticks
48 |         return "```\n" . $preContent . "```\n\n";
49 |     }
50 | 
51 |     /**
52 |      * @return string[]
53 |      */
54 |     public function getSupportedTags(): array
55 |     {
56 |         return ['pre'];
57 |     }
58 | }
59 | 


--------------------------------------------------------------------------------
/src/Converter/TableConverter.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | namespace League\HTMLToMarkdown\Converter;
  6 | 
  7 | use League\HTMLToMarkdown\Coerce;
  8 | use League\HTMLToMarkdown\Configuration;
  9 | use League\HTMLToMarkdown\ConfigurationAwareInterface;
 10 | use League\HTMLToMarkdown\ElementInterface;
 11 | use League\HTMLToMarkdown\PreConverterInterface;
 12 | 
 13 | class TableConverter implements ConverterInterface, PreConverterInterface, ConfigurationAwareInterface
 14 | {
 15 |     /** @var Configuration */
 16 |     protected $config;
 17 | 
 18 |     public function setConfig(Configuration $config): void
 19 |     {
 20 |         $this->config = $config;
 21 |     }
 22 | 
 23 |     /** @var array<string, string> */
 24 |     private static $alignments = [
 25 |         'left' => ':--',
 26 |         'right' => '--:',
 27 |         'center' => ':-:',
 28 |     ];
 29 | 
 30 |     /** @var array<int, string>|null */
 31 |     private $columnAlignments = [];
 32 | 
 33 |     /** @var string|null */
 34 |     private $caption = null;
 35 | 
 36 |     public function preConvert(ElementInterface $element): void
 37 |     {
 38 |         $tag = $element->getTagName();
 39 |         // Only table cells and caption are allowed to contain content.
 40 |         // Remove all text between other table elements.
 41 |         if ($tag === 'th' || $tag === 'td' || $tag === 'caption') {
 42 |             return;
 43 |         }
 44 | 
 45 |         foreach ($element->getChildren() as $child) {
 46 |             if ($child->isText()) {
 47 |                 $child->setFinalMarkdown('');
 48 |             }
 49 |         }
 50 |     }
 51 | 
 52 |     public function convert(ElementInterface $element): string
 53 |     {
 54 |         $value = $element->getValue();
 55 | 
 56 |         switch ($element->getTagName()) {
 57 |             case 'table':
 58 |                 $this->columnAlignments = [];
 59 |                 if ($this->caption) {
 60 |                     $side = $this->config->getOption('table_caption_side');
 61 |                     if ($side === 'top') {
 62 |                         $value = $this->caption . "\n" . $value;
 63 |                     } elseif ($side === 'bottom') {
 64 |                         $value .= $this->caption;
 65 |                     }
 66 | 
 67 |                     $this->caption = null;
 68 |                 }
 69 | 
 70 |                 return $value . "\n";
 71 |             case 'caption':
 72 |                 $this->caption = \trim($value);
 73 | 
 74 |                 return '';
 75 |             case 'tr':
 76 |                 $value .= "|\n";
 77 |                 if ($this->columnAlignments !== null) {
 78 |                     $value .= '|' . \implode('|', $this->columnAlignments) . "|\n";
 79 | 
 80 |                     $this->columnAlignments = null;
 81 |                 }
 82 | 
 83 |                 return $value;
 84 |             case 'th':
 85 |             case 'td':
 86 |                 if ($this->columnAlignments !== null) {
 87 |                     $align = $element->getAttribute('align');
 88 | 
 89 |                     $this->columnAlignments[] = self::$alignments[$align] ?? '---';
 90 |                 }
 91 | 
 92 |                 $value = \str_replace("\n", ' ', $value);
 93 |                 $value = \str_replace('|', Coerce::toString($this->config->getOption('table_pipe_escape') ?? '\|'), $value);
 94 | 
 95 |                 return '| ' . \trim($value) . ' ';
 96 |             case 'thead':
 97 |             case 'tbody':
 98 |             case 'tfoot':
 99 |             case 'colgroup':
100 |             case 'col':
101 |                 return $value;
102 |             default:
103 |                 return '';
104 |         }
105 |     }
106 | 
107 |     /**
108 |      * @return string[]
109 |      */
110 |     public function getSupportedTags(): array
111 |     {
112 |         return ['table', 'tr', 'th', 'td', 'thead', 'tbody', 'tfoot', 'colgroup', 'col', 'caption'];
113 |     }
114 | }
115 | 


--------------------------------------------------------------------------------
/src/Converter/TextConverter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown\Converter;
 6 | 
 7 | use League\HTMLToMarkdown\ElementInterface;
 8 | 
 9 | class TextConverter implements ConverterInterface
10 | {
11 |     public function convert(ElementInterface $element): string
12 |     {
13 |         $markdown = $element->getValue();
14 | 
15 |         // Remove leftover \n at the beginning of the line
16 |         $markdown = \ltrim($markdown, "\n");
17 | 
18 |         // Replace sequences of invisible characters with spaces
19 |         $markdown = \preg_replace('~\s+~u', ' ', $markdown);
20 |         \assert(\is_string($markdown));
21 | 
22 |         // Escape the following characters: '*', '_', '[', ']' and '\'
23 |         if (($parent = $element->getParent()) && $parent->getTagName() !== 'div') {
24 |             $markdown = \preg_replace('~([*_\\[\\]\\\\])~u', '\\\\$1', $markdown);
25 |             \assert(\is_string($markdown));
26 |         }
27 | 
28 |         $markdown = \preg_replace('~^#~u', '\\\\#', $markdown);
29 |         \assert(\is_string($markdown));
30 | 
31 |         if ($markdown === ' ') {
32 |             $next = $element->getNext();
33 |             if (! $next || $next->isBlock()) {
34 |                 $markdown = '';
35 |             }
36 |         }
37 | 
38 |         return \htmlspecialchars($markdown, ENT_NOQUOTES, 'UTF-8');
39 |     }
40 | 
41 |     /**
42 |      * @return string[]
43 |      */
44 |     public function getSupportedTags(): array
45 |     {
46 |         return ['#text'];
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/src/Element.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | namespace League\HTMLToMarkdown;
  6 | 
  7 | class Element implements ElementInterface
  8 | {
  9 |     /** @var \DOMNode */
 10 |     protected $node;
 11 | 
 12 |     /** @var ElementInterface|null */
 13 |     private $nextCached;
 14 | 
 15 |     /** @var \DOMNode|null */
 16 |     private $previousSiblingCached;
 17 | 
 18 |     public function __construct(\DOMNode $node)
 19 |     {
 20 |         $this->node = $node;
 21 | 
 22 |         $this->previousSiblingCached = $this->node->previousSibling;
 23 |     }
 24 | 
 25 |     public function isBlock(): bool
 26 |     {
 27 |         switch ($this->getTagName()) {
 28 |             case 'blockquote':
 29 |             case 'body':
 30 |             case 'div':
 31 |             case 'h1':
 32 |             case 'h2':
 33 |             case 'h3':
 34 |             case 'h4':
 35 |             case 'h5':
 36 |             case 'h6':
 37 |             case 'hr':
 38 |             case 'html':
 39 |             case 'li':
 40 |             case 'p':
 41 |             case 'ol':
 42 |             case 'ul':
 43 |                 return true;
 44 |             default:
 45 |                 return false;
 46 |         }
 47 |     }
 48 | 
 49 |     public function isText(): bool
 50 |     {
 51 |         return $this->getTagName() === '#text';
 52 |     }
 53 | 
 54 |     public function isWhitespace(): bool
 55 |     {
 56 |         return $this->getTagName() === '#text' && \trim($this->getValue()) === '';
 57 |     }
 58 | 
 59 |     public function getTagName(): string
 60 |     {
 61 |         return $this->node->nodeName;
 62 |     }
 63 | 
 64 |     public function getValue(): string
 65 |     {
 66 |         return $this->node->nodeValue ?? '';
 67 |     }
 68 | 
 69 |     public function hasParent(): bool
 70 |     {
 71 |         return $this->node->parentNode !== null;
 72 |     }
 73 | 
 74 |     public function getParent(): ?ElementInterface
 75 |     {
 76 |         return $this->node->parentNode ? new self($this->node->parentNode) : null;
 77 |     }
 78 | 
 79 |     public function getNextSibling(): ?ElementInterface
 80 |     {
 81 |         return $this->node->nextSibling !== null ? new self($this->node->nextSibling) : null;
 82 |     }
 83 | 
 84 |     public function getPreviousSibling(): ?ElementInterface
 85 |     {
 86 |         return $this->previousSiblingCached !== null ? new self($this->previousSiblingCached) : null;
 87 |     }
 88 | 
 89 |     public function hasChildren(): bool
 90 |     {
 91 |         return $this->node->hasChildNodes();
 92 |     }
 93 | 
 94 |     /**
 95 |      * @return ElementInterface[]
 96 |      */
 97 |     public function getChildren(): array
 98 |     {
 99 |         $ret = [];
100 |         foreach ($this->node->childNodes as $node) {
101 |             /** @psalm-suppress RedundantCondition */
102 |             \assert($node instanceof \DOMNode);
103 |             $ret[] = new self($node);
104 |         }
105 | 
106 |         return $ret;
107 |     }
108 | 
109 |     public function getNext(): ?ElementInterface
110 |     {
111 |         if ($this->nextCached === null) {
112 |             $nextNode = $this->getNextNode($this->node);
113 |             if ($nextNode !== null) {
114 |                 $this->nextCached = new self($nextNode);
115 |             }
116 |         }
117 | 
118 |         return $this->nextCached;
119 |     }
120 | 
121 |     private function getNextNode(\DOMNode $node, bool $checkChildren = true): ?\DOMNode
122 |     {
123 |         if ($checkChildren && $node->firstChild) {
124 |             return $node->firstChild;
125 |         }
126 | 
127 |         if ($node->nextSibling) {
128 |             return $node->nextSibling;
129 |         }
130 | 
131 |         if ($node->parentNode) {
132 |             return $this->getNextNode($node->parentNode, false);
133 |         }
134 | 
135 |         return null;
136 |     }
137 | 
138 |     /**
139 |      * @param string[]|string $tagNames
140 |      */
141 |     public function isDescendantOf($tagNames): bool
142 |     {
143 |         if (! \is_array($tagNames)) {
144 |             $tagNames = [$tagNames];
145 |         }
146 | 
147 |         for ($p = $this->node->parentNode; $p !== null; $p = $p->parentNode) {
148 |             if (\in_array($p->nodeName, $tagNames, true)) {
149 |                 return true;
150 |             }
151 |         }
152 | 
153 |         return false;
154 |     }
155 | 
156 |     public function setFinalMarkdown(string $markdown): void
157 |     {
158 |         if ($this->node->ownerDocument === null) {
159 |             throw new \RuntimeException('Unowned node');
160 |         }
161 | 
162 |         if ($this->node->parentNode === null) {
163 |             throw new \RuntimeException('Cannot setFinalMarkdown() on a node without a parent');
164 |         }
165 | 
166 |         $markdownNode = $this->node->ownerDocument->createTextNode($markdown);
167 |         $this->node->parentNode->replaceChild($markdownNode, $this->node);
168 |     }
169 | 
170 |     public function getChildrenAsString(): string
171 |     {
172 |         return $this->node->C14N();
173 |     }
174 | 
175 |     public function getSiblingPosition(): int
176 |     {
177 |         $position = 0;
178 | 
179 |         $parent = $this->getParent();
180 |         if ($parent === null) {
181 |             return $position;
182 |         }
183 | 
184 |         // Loop through all nodes and find the given $node
185 |         foreach ($parent->getChildren() as $currentNode) {
186 |             if (! $currentNode->isWhitespace()) {
187 |                 $position++;
188 |             }
189 | 
190 |             // TODO: Need a less-buggy way of comparing these
191 |             // Perhaps we can somehow ensure that we always have the exact same object and use === instead?
192 |             if ($this->equals($currentNode)) {
193 |                 break;
194 |             }
195 |         }
196 | 
197 |         return $position;
198 |     }
199 | 
200 |     public function getListItemLevel(): int
201 |     {
202 |         $level  = 0;
203 |         $parent = $this->getParent();
204 | 
205 |         while ($parent !== null && $parent->hasParent()) {
206 |             if ($parent->getTagName() === 'li') {
207 |                 $level++;
208 |             }
209 | 
210 |             $parent = $parent->getParent();
211 |         }
212 | 
213 |         return $level;
214 |     }
215 | 
216 |     public function getAttribute(string $name): string
217 |     {
218 |         if ($this->node instanceof \DOMElement) {
219 |             return $this->node->getAttribute($name);
220 |         }
221 | 
222 |         return '';
223 |     }
224 | 
225 |     public function equals(ElementInterface $element): bool
226 |     {
227 |         if ($element instanceof self) {
228 |             return $element->node === $this->node;
229 |         }
230 | 
231 |         return false;
232 |     }
233 | }
234 | 


--------------------------------------------------------------------------------
/src/ElementInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown;
 6 | 
 7 | interface ElementInterface
 8 | {
 9 |     public function isBlock(): bool;
10 | 
11 |     public function isText(): bool;
12 | 
13 |     public function isWhitespace(): bool;
14 | 
15 |     public function getTagName(): string;
16 | 
17 |     public function getValue(): string;
18 | 
19 |     public function hasParent(): bool;
20 | 
21 |     public function getParent(): ?ElementInterface;
22 | 
23 |     public function getNextSibling(): ?ElementInterface;
24 | 
25 |     public function getPreviousSibling(): ?ElementInterface;
26 | 
27 |     /**
28 |      * @param string|string[] $tagNames
29 |      */
30 |     public function isDescendantOf($tagNames): bool;
31 | 
32 |     public function hasChildren(): bool;
33 | 
34 |     /**
35 |      * @return ElementInterface[]
36 |      */
37 |     public function getChildren(): array;
38 | 
39 |     public function getNext(): ?ElementInterface;
40 | 
41 |     public function getSiblingPosition(): int;
42 | 
43 |     public function getChildrenAsString(): string;
44 | 
45 |     public function setFinalMarkdown(string $markdown): void;
46 | 
47 |     public function getListItemLevel(): int;
48 | 
49 |     public function getAttribute(string $name): string;
50 | }
51 | 


--------------------------------------------------------------------------------
/src/Environment.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown;
 6 | 
 7 | use League\HTMLToMarkdown\Converter\BlockquoteConverter;
 8 | use League\HTMLToMarkdown\Converter\CodeConverter;
 9 | use League\HTMLToMarkdown\Converter\CommentConverter;
10 | use League\HTMLToMarkdown\Converter\ConverterInterface;
11 | use League\HTMLToMarkdown\Converter\DefaultConverter;
12 | use League\HTMLToMarkdown\Converter\DivConverter;
13 | use League\HTMLToMarkdown\Converter\EmphasisConverter;
14 | use League\HTMLToMarkdown\Converter\HardBreakConverter;
15 | use League\HTMLToMarkdown\Converter\HeaderConverter;
16 | use League\HTMLToMarkdown\Converter\HorizontalRuleConverter;
17 | use League\HTMLToMarkdown\Converter\ImageConverter;
18 | use League\HTMLToMarkdown\Converter\LinkConverter;
19 | use League\HTMLToMarkdown\Converter\ListBlockConverter;
20 | use League\HTMLToMarkdown\Converter\ListItemConverter;
21 | use League\HTMLToMarkdown\Converter\ParagraphConverter;
22 | use League\HTMLToMarkdown\Converter\PreformattedConverter;
23 | use League\HTMLToMarkdown\Converter\TextConverter;
24 | 
25 | final class Environment
26 | {
27 |     /** @var Configuration */
28 |     protected $config;
29 | 
30 |     /** @var ConverterInterface[] */
31 |     protected $converters = [];
32 | 
33 |     /**
34 |      * @param array<string, mixed> $config
35 |      */
36 |     public function __construct(array $config = [])
37 |     {
38 |         $this->config = new Configuration($config);
39 |         $this->addConverter(new DefaultConverter());
40 |     }
41 | 
42 |     public function getConfig(): Configuration
43 |     {
44 |         return $this->config;
45 |     }
46 | 
47 |     public function addConverter(ConverterInterface $converter): void
48 |     {
49 |         if ($converter instanceof ConfigurationAwareInterface) {
50 |             $converter->setConfig($this->config);
51 |         }
52 | 
53 |         foreach ($converter->getSupportedTags() as $tag) {
54 |             $this->converters[$tag] = $converter;
55 |         }
56 |     }
57 | 
58 |     public function getConverterByTag(string $tag): ConverterInterface
59 |     {
60 |         if (isset($this->converters[$tag])) {
61 |             return $this->converters[$tag];
62 |         }
63 | 
64 |         return $this->converters[DefaultConverter::DEFAULT_CONVERTER];
65 |     }
66 | 
67 |     /**
68 |      * @param array<string, mixed> $config
69 |      */
70 |     public static function createDefaultEnvironment(array $config = []): Environment
71 |     {
72 |         $environment = new static($config);
73 | 
74 |         $environment->addConverter(new BlockquoteConverter());
75 |         $environment->addConverter(new CodeConverter());
76 |         $environment->addConverter(new CommentConverter());
77 |         $environment->addConverter(new DivConverter());
78 |         $environment->addConverter(new EmphasisConverter());
79 |         $environment->addConverter(new HardBreakConverter());
80 |         $environment->addConverter(new HeaderConverter());
81 |         $environment->addConverter(new HorizontalRuleConverter());
82 |         $environment->addConverter(new ImageConverter());
83 |         $environment->addConverter(new LinkConverter());
84 |         $environment->addConverter(new ListBlockConverter());
85 |         $environment->addConverter(new ListItemConverter());
86 |         $environment->addConverter(new ParagraphConverter());
87 |         $environment->addConverter(new PreformattedConverter());
88 |         $environment->addConverter(new TextConverter());
89 | 
90 |         return $environment;
91 |     }
92 | }
93 | 


--------------------------------------------------------------------------------
/src/HtmlConverter.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | namespace League\HTMLToMarkdown;
  6 | 
  7 | /**
  8 |  * A helper class to convert HTML to Markdown.
  9 |  *
 10 |  * @author Colin O'Dell <colinodell@gmail.com>
 11 |  * @author Nick Cernis <nick@cern.is>
 12 |  *
 13 |  * @link https://github.com/thephpleague/html-to-markdown/ Latest version on GitHub.
 14 |  *
 15 |  * @license http://www.opensource.org/licenses/mit-license.php MIT
 16 |  */
 17 | class HtmlConverter implements HtmlConverterInterface
 18 | {
 19 |     /** @var Environment */
 20 |     protected $environment;
 21 | 
 22 |     /**
 23 |      * Constructor
 24 |      *
 25 |      * @param Environment|array<string, mixed> $options Environment object or configuration options
 26 |      */
 27 |     public function __construct($options = [])
 28 |     {
 29 |         if ($options instanceof Environment) {
 30 |             $this->environment = $options;
 31 |         } elseif (\is_array($options)) {
 32 |             $defaults = [
 33 |                 'header_style' => 'setext', // Set to 'atx' to output H1 and H2 headers as # Header1 and ## Header2
 34 |                 'suppress_errors' => true, // Set to false to show warnings when loading malformed HTML
 35 |                 '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.
 36 |                 'strip_placeholder_links' => false, // Set to true to remove <a> that doesn't have href.
 37 |                 'bold_style' => '**', // DEPRECATED: Set to '__' if you prefer the underlined style
 38 |                 'italic_style' => '*', // DEPRECATED: Set to '_' if you prefer the underlined style
 39 |                 'remove_nodes' => '', // space-separated list of dom nodes that should be removed. example: 'meta style script'
 40 |                 'hard_break' => false, // Set to true to turn <br> into `\n` instead of `  \n`
 41 |                 'list_item_style' => '-', // Set the default character for each <li> in a <ul>. Can be '-', '*', or '+'
 42 |                 'preserve_comments' => false, // Set to true to preserve comments, or set to an array of strings to preserve specific comments
 43 |                 'use_autolinks' => true, // Set to true to use simple link syntax if possible. Will always use []() if set to false
 44 |                 'table_pipe_escape' => '\|', // Replacement string for pipe characters inside markdown table cells
 45 |                 'table_caption_side' => 'top', // Set to 'top' or 'bottom' to show <caption> content before or after table, null to suppress
 46 |             ];
 47 | 
 48 |             $this->environment = Environment::createDefaultEnvironment($defaults);
 49 | 
 50 |             $this->environment->getConfig()->merge($options);
 51 |         }
 52 |     }
 53 | 
 54 |     public function getEnvironment(): Environment
 55 |     {
 56 |         return $this->environment;
 57 |     }
 58 | 
 59 |     public function getConfig(): Configuration
 60 |     {
 61 |         return $this->environment->getConfig();
 62 |     }
 63 | 
 64 |     /**
 65 |      * Convert
 66 |      *
 67 |      * @see HtmlConverter::convert
 68 |      *
 69 |      * @return string The Markdown version of the html
 70 |      */
 71 |     public function __invoke(string $html): string
 72 |     {
 73 |         return $this->convert($html);
 74 |     }
 75 | 
 76 |     /**
 77 |      * Convert
 78 |      *
 79 |      * Loads HTML and passes to getMarkdown()
 80 |      *
 81 |      * @return string The Markdown version of the html
 82 |      *
 83 |      * @throws \InvalidArgumentException|\RuntimeException
 84 |      */
 85 |     public function convert(string $html): string
 86 |     {
 87 |         if (\trim($html) === '') {
 88 |             return '';
 89 |         }
 90 | 
 91 |         $document = $this->createDOMDocument($html);
 92 | 
 93 |         // Work on the entire DOM tree (including head and body)
 94 |         if (! ($root = $document->getElementsByTagName('html')->item(0))) {
 95 |             throw new \InvalidArgumentException('Invalid HTML was provided');
 96 |         }
 97 | 
 98 |         $rootElement = new Element($root);
 99 |         $this->convertChildren($rootElement);
100 | 
101 |         // Store the now-modified DOMDocument as a string
102 |         $markdown = $document->saveHTML();
103 | 
104 |         if ($markdown === false) {
105 |             throw new \RuntimeException('Unknown error occurred during HTML to Markdown conversion');
106 |         }
107 | 
108 |         return $this->sanitize($markdown);
109 |     }
110 | 
111 |     private function createDOMDocument(string $html): \DOMDocument
112 |     {
113 |         $document = new \DOMDocument();
114 | 
115 |         if ($this->getConfig()->getOption('suppress_errors')) {
116 |             // Suppress conversion errors (from http://bit.ly/pCCRSX)
117 |             \libxml_use_internal_errors(true);
118 |         }
119 | 
120 |         // Hack to load utf-8 HTML (from http://bit.ly/pVDyCt)
121 |         $document->loadHTML('<?xml encoding="UTF-8">' . $html);
122 |         $document->encoding = 'UTF-8';
123 | 
124 |         $this->replaceMisplacedComments($document);
125 | 
126 |         if ($this->getConfig()->getOption('suppress_errors')) {
127 |             \libxml_clear_errors();
128 |         }
129 | 
130 |         return $document;
131 |     }
132 | 
133 |     /**
134 |      * Finds any comment nodes outside <html> element and moves them into <body>.
135 |      *
136 |      * @see https://github.com/thephpleague/html-to-markdown/issues/212
137 |      * @see https://3v4l.org/7bC33
138 |      */
139 |     private function replaceMisplacedComments(\DOMDocument $document): void
140 |     {
141 |         // Find ny comment nodes at the root of the document.
142 |         $misplacedComments = (new \DOMXPath($document))->query('/comment()');
143 |         if ($misplacedComments === false) {
144 |             return;
145 |         }
146 | 
147 |         $body = $document->getElementsByTagName('body')->item(0);
148 |         if ($body === null) {
149 |             return;
150 |         }
151 | 
152 |         // Loop over comment nodes in reverse so we put them inside <body> in
153 |         // their original order.
154 |         for ($index = $misplacedComments->length - 1; $index >= 0; $index--) {
155 |             if ($body->firstChild === null) {
156 |                 $body->insertBefore($misplacedComments[$index]);
157 |             } else {
158 |                 $body->insertBefore($misplacedComments[$index], $body->firstChild);
159 |             }
160 |         }
161 |     }
162 | 
163 |     /**
164 |      * Convert Children
165 |      *
166 |      * Recursive function to drill into the DOM and convert each node into Markdown from the inside out.
167 |      *
168 |      * Finds children of each node and convert those to #text nodes containing their Markdown equivalent,
169 |      * starting with the innermost element and working up to the outermost element.
170 |      */
171 |     private function convertChildren(ElementInterface $element): void
172 |     {
173 |         // Don't convert HTML code inside <code> and <pre> blocks to Markdown - that should stay as HTML
174 |         // except if the current node is a code tag, which needs to be converted by the CodeConverter.
175 |         if ($element->isDescendantOf(['pre', 'code']) && $element->getTagName() !== 'code') {
176 |             return;
177 |         }
178 | 
179 |         // Give converter a chance to inspect/modify the DOM before children are converted
180 |         $converter = $this->environment->getConverterByTag($element->getTagName());
181 |         if ($converter instanceof PreConverterInterface) {
182 |             $converter->preConvert($element);
183 |         }
184 | 
185 |         // If the node has children, convert those to Markdown first
186 |         if ($element->hasChildren()) {
187 |             foreach ($element->getChildren() as $child) {
188 |                 $this->convertChildren($child);
189 |             }
190 |         }
191 | 
192 |         // Now that child nodes have been converted, convert the original node
193 |         $markdown = $this->convertToMarkdown($element);
194 | 
195 |         // Create a DOM text node containing the Markdown equivalent of the original node
196 | 
197 |         // Replace the old $node e.g. '<h3>Title</h3>' with the new $markdown_node e.g. '### Title'
198 |         $element->setFinalMarkdown($markdown);
199 |     }
200 | 
201 |     /**
202 |      * Convert to Markdown
203 |      *
204 |      * Converts an individual node into a #text node containing a string of its Markdown equivalent.
205 |      *
206 |      * Example: An <h3> node with text content of 'Title' becomes a text node with content of '### Title'
207 |      *
208 |      * @return string The converted HTML as Markdown
209 |      */
210 |     protected function convertToMarkdown(ElementInterface $element): string
211 |     {
212 |         $tag = $element->getTagName();
213 | 
214 |         // Strip nodes named in remove_nodes
215 |         $tagsToRemove = \explode(' ', Coerce::toString($this->getConfig()->getOption('remove_nodes') ?? ''));
216 |         if (\in_array($tag, $tagsToRemove, true)) {
217 |             return '';
218 |         }
219 | 
220 |         $converter = $this->environment->getConverterByTag($tag);
221 | 
222 |         return $converter->convert($element);
223 |     }
224 | 
225 |     protected function sanitize(string $markdown): string
226 |     {
227 |         $markdown = \html_entity_decode($markdown, ENT_QUOTES, 'UTF-8');
228 |         $markdown = \preg_replace('/<!DOCTYPE [^>]+>/', '', $markdown); // Strip doctype declaration
229 |         \assert($markdown !== null);
230 |         $markdown = \trim($markdown); // Remove blank spaces at the beggining of the html
231 | 
232 |         /*
233 |          * Removing unwanted tags. Tags should be added to the array in the order they are expected.
234 |          * XML, html and body opening tags should be in that order. Same case with closing tags
235 |          */
236 |         $unwanted = ['<?xml encoding="UTF-8">', '<html>', '</html>', '<body>', '</body>', '<head>', '</head>', '&#xD;'];
237 | 
238 |         foreach ($unwanted as $tag) {
239 |             if (\strpos($tag, '/') === false) {
240 |                 // Opening tags
241 |                 if (\strpos($markdown, $tag) === 0) {
242 |                     $markdown = \substr($markdown, \strlen($tag));
243 |                 }
244 |             } else {
245 |                 // Closing tags
246 |                 if (\strpos($markdown, $tag) === \strlen($markdown) - \strlen($tag)) {
247 |                     $markdown = \substr($markdown, 0, -\strlen($tag));
248 |                 }
249 |             }
250 |         }
251 | 
252 |         return \trim($markdown, "\n\r\0\x0B");
253 |     }
254 | 
255 |     /**
256 |      * Pass a series of key-value pairs in an array; these will be passed
257 |      * through the config and set.
258 |      * The advantage of this is that it can allow for static use (IE in Laravel).
259 |      * An example being:
260 |      *
261 |      * HtmlConverter::setOptions(['strip_tags' => true])->convert('<h1>test</h1>');
262 |      *
263 |      * @param array<string, mixed> $options
264 |      *
265 |      * @return $this
266 |      */
267 |     public function setOptions(array $options)
268 |     {
269 |         $config = $this->getConfig();
270 | 
271 |         foreach ($options as $key => $option) {
272 |             $config->setOption($key, $option);
273 |         }
274 | 
275 |         return $this;
276 |     }
277 | }
278 | 


--------------------------------------------------------------------------------
/src/HtmlConverterInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown;
 6 | 
 7 | /**
 8 |  * Interface for an HTML-to-Markdown converter.
 9 |  *
10 |  * @author Colin O'Dell <colinodell@gmail.com>
11 |  *
12 |  * @link https://github.com/thephpleague/html-to-markdown/ Latest version on GitHub.
13 |  *
14 |  * @license http://www.opensource.org/licenses/mit-license.php MIT
15 |  */
16 | interface HtmlConverterInterface
17 | {
18 |     /**
19 |      * Convert the given $html to Markdown
20 |      *
21 |      * @return string The Markdown version of the html
22 |      *
23 |      * @throws \InvalidArgumentException
24 |      */
25 |     public function convert(string $html): string;
26 | }
27 | 


--------------------------------------------------------------------------------
/src/PreConverterInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace League\HTMLToMarkdown;
 6 | 
 7 | interface PreConverterInterface
 8 | {
 9 |     public function preConvert(ElementInterface $element): void;
10 | }
11 | 


--------------------------------------------------------------------------------