| 1: | <?php |
| 2: | |
| 3: | /* |
| 4: | * The MIT License (MIT) |
| 5: | * |
| 6: | * Copyright (c) 2013 Jonathan Vollebregt (jnvsor@gmail.com), Rokas Šleinius (raveren@gmail.com) |
| 7: | * |
| 8: | * Permission is hereby granted, free of charge, to any person obtaining a copy of |
| 9: | * this software and associated documentation files (the "Software"), to deal in |
| 10: | * the Software without restriction, including without limitation the rights to |
| 11: | * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of |
| 12: | * the Software, and to permit persons to whom the Software is furnished to do so, |
| 13: | * subject to the following conditions: |
| 14: | * |
| 15: | * The above copyright notice and this permission notice shall be included in all |
| 16: | * copies or substantial portions of the Software. |
| 17: | * |
| 18: | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 19: | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS |
| 20: | * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR |
| 21: | * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER |
| 22: | * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN |
| 23: | * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 24: | */ |
| 25: | |
| 26: | namespace Kint\Object\Representation; |
| 27: | |
| 28: | class DocstringRepresentation extends Representation |
| 29: | { |
| 30: | public $file; |
| 31: | public $line; |
| 32: | public $class; |
| 33: | public $hints = array('docstring'); |
| 34: | |
| 35: | public function __construct($docstring, $file, $line, $class = null) |
| 36: | { |
| 37: | parent::__construct('Docstring'); |
| 38: | |
| 39: | $this->file = $file; |
| 40: | $this->line = $line; |
| 41: | $this->class = $class; |
| 42: | $this->contents = $docstring; |
| 43: | } |
| 44: | |
| 45: | /** |
| 46: | * Returns the representation's docstring without surrounding comments. |
| 47: | * |
| 48: | * Note that this will not work flawlessly. |
| 49: | * |
| 50: | * On comments with whitespace after the stars the lines will begin with |
| 51: | * whitespace, since we can't accurately guess how much of an indentation |
| 52: | * is required. |
| 53: | * |
| 54: | * And on lines without stars on the left this may eat bullet points. |
| 55: | * |
| 56: | * Long story short: If you want the docstring read the contents. If you |
| 57: | * absolutely must have it without comments (ie renderValueShort) this will |
| 58: | * probably do. |
| 59: | * |
| 60: | * @return null|string Docstring with comments stripped |
| 61: | */ |
| 62: | public function getDocstringWithoutComments() |
| 63: | { |
| 64: | if (!$this->contents) { |
| 65: | return null; |
| 66: | } |
| 67: | |
| 68: | $string = \substr($this->contents, 3, -2); |
| 69: | $string = \preg_replace('/^\\s*\\*\\s*?(\\S|$)/m', '\\1', $string); |
| 70: | |
| 71: | return \trim($string); |
| 72: | } |
| 73: | } |
| 74: |