226 lines
6.8 KiB
PHP
226 lines
6.8 KiB
PHP
|
<?php
|
||
|
|
||
|
namespace Grav\Theme\ProjectSpace;
|
||
|
|
||
|
use DOMText;
|
||
|
use DOMDocument;
|
||
|
use DOMWordsIterator;
|
||
|
use DOMLettersIterator;
|
||
|
|
||
|
/**
|
||
|
* TruncateExtension
|
||
|
*
|
||
|
* @author Alex Wilson <ajw@bluetel.co.uk>
|
||
|
* @license http://www.opensource.org/licenses/mit-license.html MIT License
|
||
|
* @link https://github.com/bluetel/twig-truncate-extension
|
||
|
*/
|
||
|
class TruncateTwigExtension extends \Twig_Extension
|
||
|
{
|
||
|
public function getName()
|
||
|
{
|
||
|
return 'Truncate';
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Undocumented Register filters
|
||
|
*
|
||
|
* @return array List of filters supplied by this extension.
|
||
|
*/
|
||
|
public function getFilters()
|
||
|
{
|
||
|
$truncateWords = new \Twig_SimpleFilter(
|
||
|
'truncate_words',
|
||
|
array($this, 'truncateWords'),
|
||
|
array(
|
||
|
'is_safe' => array('html'),
|
||
|
)
|
||
|
);
|
||
|
|
||
|
$truncateLetters = new \Twig_SimpleFilter(
|
||
|
'truncate_letters',
|
||
|
array($this, 'truncateLetters'),
|
||
|
array(
|
||
|
'is_safe' => array('html'),
|
||
|
)
|
||
|
);
|
||
|
|
||
|
return array(
|
||
|
'truncate_letters' => $truncateWords,
|
||
|
'truncate_words' => $truncateLetters,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Safely truncates HTML by a given number of words.
|
||
|
* @param string $html Input HTML.
|
||
|
* @param integer $limit Limit to how many words we preserve.
|
||
|
* @param string $ellipsis String to use as ellipsis (if any).
|
||
|
* @return string Safe truncated HTML.
|
||
|
*/
|
||
|
public function truncateWords($html, $limit = 0, $ellipsis = "")
|
||
|
{
|
||
|
if ($limit <= 0) {
|
||
|
return $html;
|
||
|
}
|
||
|
if (empty($html)) {
|
||
|
return false;
|
||
|
}
|
||
|
|
||
|
$dom = $this->htmlToDomDocument($html);
|
||
|
|
||
|
// Grab the body of our DOM.
|
||
|
$body = $dom->getElementsByTagName("body")->item(0);
|
||
|
|
||
|
// Iterate over words.
|
||
|
$words = new DOMWordsIterator($body);
|
||
|
foreach ($words as $word) {
|
||
|
|
||
|
// If we have exceeded the limit, we delete the remainder of the content.
|
||
|
if ($words->key() >= $limit) {
|
||
|
|
||
|
// Grab current position.
|
||
|
$currentWordPosition = $words->currentWordPosition();
|
||
|
$curNode = $currentWordPosition[0];
|
||
|
$offset = $currentWordPosition[1];
|
||
|
$words = $currentWordPosition[2];
|
||
|
|
||
|
$curNode->nodeValue = substr(
|
||
|
$curNode->nodeValue,
|
||
|
0,
|
||
|
$words[$offset][1] + strlen($words[$offset][0])
|
||
|
);
|
||
|
|
||
|
self::removeProceedingNodes($curNode, $body);
|
||
|
|
||
|
if (!empty($ellipsis)) {
|
||
|
self::insertEllipsis($curNode, $ellipsis);
|
||
|
}
|
||
|
|
||
|
break;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
return $dom->saveHTML();
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Safely truncates HTML by a given number of letters.
|
||
|
* @param string $html Input HTML.
|
||
|
* @param integer $limit Limit to how many letters we preserve.
|
||
|
* @param string $ellipsis String to use as ellipsis (if any).
|
||
|
* @return string Safe truncated HTML.
|
||
|
*/
|
||
|
public function truncateLetters($html, $limit = 0, $ellipsis = "")
|
||
|
{
|
||
|
if ($limit <= 0) {
|
||
|
return $html;
|
||
|
}
|
||
|
if (empty($html)) {
|
||
|
return false;
|
||
|
}
|
||
|
|
||
|
$dom = $this->htmlToDomDocument($html);
|
||
|
|
||
|
// Grab the body of our DOM.
|
||
|
$body = $dom->getElementsByTagName("body")->item(0);
|
||
|
|
||
|
// Iterate over letters.
|
||
|
$letters = new DOMLettersIterator($body);
|
||
|
foreach ($letters as $letter) {
|
||
|
|
||
|
// If we have exceeded the limit, we want to delete the remainder of this document.
|
||
|
if ($letters->key() >= $limit) {
|
||
|
|
||
|
$currentText = $letters->currentTextPosition();
|
||
|
$currentText[0]->nodeValue = substr($currentText[0]->nodeValue, 0, $currentText[1] + 1);
|
||
|
self::removeProceedingNodes($currentText[0], $body);
|
||
|
|
||
|
if (!empty($ellipsis)) {
|
||
|
self::insertEllipsis($currentText[0], $ellipsis);
|
||
|
}
|
||
|
|
||
|
break;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
return $dom->saveHTML();
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Builds a DOMDocument object from a string containing HTML.
|
||
|
* @param string HTML to load
|
||
|
* @returns DOMDocument Returns a DOMDocument object.
|
||
|
*/
|
||
|
public function htmlToDomDocument($html)
|
||
|
{
|
||
|
if (empty($html)) {
|
||
|
return false;
|
||
|
}
|
||
|
// Transform multibyte entities which otherwise display incorrectly.
|
||
|
$html = mb_convert_encoding($html, 'HTML-ENTITIES', 'UTF-8');
|
||
|
|
||
|
// Internal errors enabled as HTML5 not fully supported.
|
||
|
libxml_use_internal_errors(true);
|
||
|
|
||
|
// Instantiate new DOMDocument object, and then load in UTF-8 HTML.
|
||
|
$dom = new DOMDocument();
|
||
|
$dom->encoding = 'UTF-8';
|
||
|
$dom->loadHTML($html);
|
||
|
|
||
|
return $dom;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Removes all nodes after the current node.
|
||
|
* @param DOMNode|DOMElement $domNode
|
||
|
* @param DOMNode|DOMElement $topNode
|
||
|
* @return void
|
||
|
*/
|
||
|
private static function removeProceedingNodes($domNode, $topNode)
|
||
|
{
|
||
|
$nextNode = $domNode->nextSibling;
|
||
|
|
||
|
if ($nextNode !== null) {
|
||
|
self::removeProceedingNodes($nextNode, $topNode);
|
||
|
$domNode->parentNode->removeChild($nextNode);
|
||
|
} else {
|
||
|
//scan upwards till we find a sibling
|
||
|
$curNode = $domNode->parentNode;
|
||
|
while ($curNode !== $topNode) {
|
||
|
if ($curNode->nextSibling !== null) {
|
||
|
$curNode = $curNode->nextSibling;
|
||
|
self::removeProceedingNodes($curNode, $topNode);
|
||
|
$curNode->parentNode->removeChild($curNode);
|
||
|
break;
|
||
|
}
|
||
|
$curNode = $curNode->parentNode;
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Inserts an ellipsis
|
||
|
* @param DOMNode|DOMElement $domNode Element to insert after.
|
||
|
* @param string $ellipsis Text used to suffix our document.
|
||
|
* @return void
|
||
|
*/
|
||
|
private static function insertEllipsis($domNode, $ellipsis)
|
||
|
{
|
||
|
$avoid = array('a', 'strong', 'em', 'h1', 'h2', 'h3', 'h4', 'h5'); //html tags to avoid appending the ellipsis to
|
||
|
|
||
|
if (in_array($domNode->parentNode->nodeName, $avoid) && $domNode->parentNode->parentNode !== null) {
|
||
|
// Append as text node to parent instead
|
||
|
$textNode = new DOMText($ellipsis);
|
||
|
|
||
|
if ($domNode->parentNode->parentNode->nextSibling) {
|
||
|
$domNode->parentNode->parentNode->insertBefore($textNode, $domNode->parentNode->parentNode->nextSibling);
|
||
|
} else {
|
||
|
$domNode->parentNode->parentNode->appendChild($textNode);
|
||
|
}
|
||
|
} else {
|
||
|
// Append to current node
|
||
|
$domNode->nodeValue = rtrim($domNode->nodeValue) . $ellipsis;
|
||
|
}
|
||
|
}
|
||
|
}
|