SeaCMS/pico
3
0
Fork 0
Code Issues Pull Requests Activity

Remove default plugins PicoParsePagesContent and PicoExcerpt

Browse Source 
As previously announced (see [Upgrade to Pico 1.0 page](http://picocms.org/in-depth/upgrade/)) we'll remove the default plugins `PicoParsePagesContent` and `PicoExcerpt` with the next Pico milestone. Needless to say, that you can still install both plugins without any problem - we'll add them to Pico's official [Plugins collection](http://picocms.org/plugins/) by then. Please note that the disadvantages of these plugins are still critical and we strongly advise to not use them. Please refer to the [Upgrade to Pico 1.0 page](http://picocms.org/in-depth/upgrade/) for details.
This commit is contained in:
Daniel Rudolf 2016-12-06 19:31:29 +01:00
parent 5cf47e65de
commit ea2146b2db
No known key found for this signature in database
GPG Key ID: A061F02CD8DE4538
2 changed files with 0 additions and 121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
plugins/01-PicoParsePagesContent.php
View File

@ -1,40 +0,0 @@
<?php
/**
* Parses the contents of all pages
*
* This plugin exists for backward compatibility and is disabled by default.
* It gets automatically enabled when {@link PicoDeprecated} is enabled. You
* can avoid this by calling {@link PicoParsePagesContent::setEnabled()}.
*
* This plugin heavily impacts Pico's performance, you should avoid to enable
* it whenever possible! If you must parse the contents of a page, do this
* selectively and only for pages you really need to.
*
* @author Daniel Rudolf
* @link http://picocms.org
* @license http://opensource.org/licenses/MIT The MIT License
* @version 1.0
*/
class PicoParsePagesContent extends AbstractPicoPlugin
{
/**
* This plugin is disabled by default
*
* @see AbstractPicoPlugin::$enabled
*/
protected $enabled = false;
/**
* Parses the contents of all pages
*
* @see DummyPlugin::onSinglePageLoaded()
*/
public function onSinglePageLoaded(array &$pageData)
{
if (!isset($pageData['content'])) {
$pageData['content'] = $this->prepareFileContent($pageData['raw_content'], $pageData['meta']);
$pageData['content'] = $this->parseFileContent($pageData['content']);
}
}
}

81
plugins/02-PicoExcerpt.php
View File

@ -1,81 +0,0 @@
<?php
/**
* Creates a excerpt for the contents of each page (as of Pico v0.9 and older)
*
* This plugin exists for backward compatibility and is disabled by default.
* It gets automatically enabled when {@link PicoDeprecated} is enabled. You
* can avoid this by calling {@link PicoExcerpt::setEnabled()}.
*
* This plugin doesn't do its job very well and depends on
* {@link PicoParsePagesContent}, what heavily impacts Pico's performance. You
* should either use the Description meta header field or write something own.
* Best solution seems to be a filter for twig, see e.g.
* {@link https://gist.github.com/james2doyle/6629712}.
*
* @author Daniel Rudolf
* @link http://picocms.org
* @license http://opensource.org/licenses/MIT The MIT License
* @version 1.0
*/
class PicoExcerpt extends AbstractPicoPlugin
{
/**
* This plugin is disabled by default
*
* @see AbstractPicoPlugin::$enabled
*/
protected $enabled = false;
/**
* This plugin depends on PicoParsePagesContent
*
* @see PicoParsePagesContent
* @see AbstractPicoPlugin::$dependsOn
*/
protected $dependsOn = array('PicoParsePagesContent');
/**
* Adds the default excerpt length of 50 words to the config
*
* @see DummyPlugin::onConfigLoaded()
*/
public function onConfigLoaded(array &$config)
{
if (!isset($config['excerpt_length'])) {
$config['excerpt_length'] = 50;
}
}
/**
* Creates a excerpt for the contents of each page
*
* @see PicoExcerpt::createExcerpt()
* @see DummyPlugin::onSinglePageLoaded()
*/
public function onSinglePageLoaded(array &$pageData)
{
if (!isset($pageData['excerpt'])) {
$pageData['excerpt'] = $this->createExcerpt(
strip_tags($pageData['content']),
$this->getConfig('excerpt_length')
);
}
}
/**
* Helper function to create a excerpt of a string
*
* @param string $string the string to create a excerpt from
* @param int $wordLimit the maximum number of words the excerpt should be long
* @return string excerpt of $string
*/
protected function createExcerpt($string, $wordLimit)
{
$words = explode(' ', $string);
if (count($words) > $wordLimit) {
return trim(implode(' ', array_slice($words, 0, $wordLimit))) . '&hellip;';
}
return $string;
}
}