Skip to content

Commit

Permalink
Quick Fix Summary issues (#1554)
Browse files Browse the repository at this point in the history 
* Quick Fix Summary issues

1. Calculate the string size without any html tags, so now you can get exactly what you wanted length;
2. Support utf8 2 character widths characters, like Chinese, Japanese;
3. This is a quick dirty mod, some associated functions should be rethinked;

* fix: Add an option to compatibel with old version

Now, you can use page.summary(10) as normal, or page.summary(10, true) to ignore all html tags and medias

* fit PS2R coding style

* psr-2 reformated without assignment align
  • Loading branch information
@ash0080 @rhukster
ash0080 authored and rhukster committed Aug 22, 2017
1 parent 4cf5f00 commit 39af369
Showing 1 changed file with 49 additions and 24 deletions.
73 changes: 49 additions & 24 deletions system/src/Grav/Common/Page/Page.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ public function __construct()
* Initializes the page instance variables based on a file
*
* @param \SplFileInfo $file The file information for the .md file that the page represents
* @param string $extension
* @param string $extension
*
* @return $this
*/
Expand Down Expand Up @@ -331,7 +331,8 @@ public function header($var = null)
$frontmatter_file = $this->path . '/' . $this->folder . '/frontmatter.yaml';
if (file_exists($frontmatter_file)) {
$frontmatter_data = (array)Yaml::parse(file_get_contents($frontmatter_file));
$this->header = (object)array_replace_recursive($frontmatter_data, (array)$this->header);
$this->header = (object)array_replace_recursive($frontmatter_data,
(array)$this->header);
}
// Process frontmatter with Twig if enabled
if (Grav::instance()['config']->get('system.pages.frontmatter.process_twig') === true) {
Expand Down Expand Up @@ -485,9 +486,11 @@ public function modifyHeader($key, $value)
*
* @param int $size Max summary size.
*
* @param boolean $textOnly Only count text size.
*
* @return string
*/
public function summary($size = null)
public function summary($size = null, $textOnly = false)
{
$config = (array)Grav::instance()['config']->get('site.summary');
if (isset($this->header->summary)) {
Expand All @@ -501,11 +504,12 @@ public function summary($size = null)

// Set up variables to process summary from page or from custom summary
if ($this->summary === null) {
$content = $this->content();
$content = $textOnly ? strip_tags($this->content()) : $this->content();
$summary_size = $this->summary_size;
} else {
$content = $this->summary;
$summary_size = mb_strlen($this->summary);
$content = strip_tags($this->summary);
// Use mb_strwidth to deal with the 2 character widths characters
$summary_size = mb_strwidth($content, 'utf-8');
}

// Return calculated summary based on summary divider's position
Expand All @@ -514,7 +518,12 @@ public function summary($size = null)
if (!in_array($format, ['short', 'long'])) {
return $content;
} elseif (($format === 'short') && isset($summary_size)) {
return mb_substr($content, 0, $summary_size);
// Use mb_strimwidth to slice the string
if (mb_strwidth($content, 'utf8') > $summary_size) {
return mb_strimwidth($content, 0, $summary_size);
} else {
return $content;
}
}

// Get summary size from site config's file
Expand All @@ -530,6 +539,15 @@ public function summary($size = null)
$size = 300;
}

// Only return string but not html, wrap whatever html tag you want when using
if ($textOnly) {
if (mb_strwidth($content, 'utf-8') <= $size) {
return $content;
}

return mb_strimwidth($content, 0, $size, '...', 'utf-8');
}

$summary = Utils::truncateHTML($content, $size);

return html_entity_decode($summary);
Expand Down Expand Up @@ -590,7 +608,7 @@ public function content($var = null)


$process_markdown = $this->shouldProcess('markdown');
$process_twig = $this->shouldProcess('twig') || $this->modularTwig() ;
$process_twig = $this->shouldProcess('twig') || $this->modularTwig();

$cache_enable = isset($this->header->cache_enable) ? $this->header->cache_enable : $config->get('system.cache.enabled',
true);
Expand Down Expand Up @@ -801,7 +819,7 @@ public function setRawContent($content)
* Get value from a page variable (used mostly for creating edit forms).
*
* @param string $name Variable name.
* @param mixed $default
* @param mixed $default
*
* @return mixed
*/
Expand Down Expand Up @@ -1078,7 +1096,7 @@ public function extra()
public function toArray()
{
return [
'header' => (array)$this->header(),
'header' => (array)$this->header(),
'content' => (string)$this->value('content')
];
}
Expand Down Expand Up @@ -1486,9 +1504,9 @@ public function metadata($var = null)
foreach ($value as $property => $prop_value) {
$prop_key = $key . ":" . $property;
$this->metadata[$prop_key] = [
'name' => $prop_key,
'name' => $prop_key,
'property' => $prop_key,
'content' => htmlspecialchars($prop_value, ENT_QUOTES, 'UTF-8')
'content' => htmlspecialchars($prop_value, ENT_QUOTES, 'UTF-8')
];
}
} else {
Expand All @@ -1497,15 +1515,18 @@ public function metadata($var = null)
if (in_array($key, $header_tag_http_equivs)) {
$this->metadata[$key] = [
'http_equiv' => $key,
'content' => htmlspecialchars($value, ENT_QUOTES, 'UTF-8')
'content' => htmlspecialchars($value, ENT_QUOTES, 'UTF-8')
];
} elseif ($key == 'charset') {
$this->metadata[$key] = ['charset' => htmlspecialchars($value, ENT_QUOTES, 'UTF-8')];
} else {
// if it's a social metadata with separator, render as property
$separator = strpos($key, ':');
$hasSeparator = $separator && $separator < strlen($key) - 1;
$entry = ['name' => $key, 'content' => htmlspecialchars($value, ENT_QUOTES, 'UTF-8')];
$entry = [
'name' => $key,
'content' => htmlspecialchars($value, ENT_QUOTES, 'UTF-8')
];

if ($hasSeparator) {
$entry['property'] = $key;
Expand Down Expand Up @@ -1589,6 +1610,7 @@ public function permalink()
* Returns the canonical URL for a page
*
* @param bool $include_lang
*
* @return string
*/
public function canonical($include_lang = true)
Expand All @@ -1603,6 +1625,7 @@ public function canonical($include_lang = true)
* @param bool $canonical true to return the canonical URL
* @param bool $include_lang
* @param bool $raw_route
*
* @return string The url.
*/
public function url($include_host = false, $canonical = false, $include_lang = true, $raw_route = false)
Expand Down Expand Up @@ -2327,7 +2350,7 @@ public function root()
* Helper method to return an ancestor page.
*
* @param string $url The url of the page
* @param bool $lookup Name of the parent folder
* @param bool $lookup Name of the parent folder
*
* @return \Grav\Common\Page\Page page you were looking for if it exists
*/
Expand All @@ -2343,7 +2366,7 @@ public function ancestor($lookup = null)
* Helper method to return an ancestor page to inherit from. The current
* page object is returned.
*
* @param string $field Name of the parent folder
* @param string $field Name of the parent folder
*
* @return Page
*/
Expand All @@ -2355,11 +2378,12 @@ public function inherited($field)

return $inherited;
}

/**
* Helper method to return an ancestor field only to inherit from. The
* first occurrence of an ancestor field will be returned if at all.
*
* @param string $field Name of the parent folder
* @param string $field Name of the parent folder
*
* @return array
*/
Expand All @@ -2373,7 +2397,7 @@ public function inheritedField($field)
/**
* Method that contains shared logic for inherited() and inheritedField()
*
* @param string $field Name of the parent folder
* @param string $field Name of the parent folder
*
* @return array
*/
Expand All @@ -2383,19 +2407,20 @@ protected function getInheritedParams($field)

/** @var Pages $pages */
$inherited = $pages->inherited($this->route, $field);
$inheritedParams = (array) $inherited->value('header.' . $field);
$currentParams = (array) $this->value('header.' . $field);
if($inheritedParams && is_array($inheritedParams)) {
$inheritedParams = (array)$inherited->value('header.' . $field);
$currentParams = (array)$this->value('header.' . $field);
if ($inheritedParams && is_array($inheritedParams)) {
$currentParams = array_replace_recursive($inheritedParams, $currentParams);
}

return [$inherited, $currentParams];
}

/**
* Helper method to return a page.
*
* @param string $url the url of the page
* @param bool $all
* @param bool $all
*
* @return \Grav\Common\Page\Page page you were looking for if it exists
*/
Expand All @@ -2411,7 +2436,7 @@ public function find($url, $all = false)
* Get a collection of pages in the current context.
*
* @param string|array $params
* @param boolean $pagination
* @param boolean $pagination
*
* @return Collection
* @throws \InvalidArgumentException
Expand Down Expand Up @@ -2747,7 +2772,7 @@ protected function doReorder($new_order)

// Reorder all moved pages.
foreach ($siblings as $slug => $page) {
$order = intval(trim($page->order(),'.'));
$order = intval(trim($page->order(), '.'));
$counter++;

if ($order) {
Expand Down

0 comments on commit 39af369

Please sign in to comment.