Maslosoft Staple API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 <?php
/**
* This software package is licensed under AGPL or Commercial license.
*
* @package maslosoft/staple
* @licence AGPL or Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
* @copyright Copyright (c) Maslosoft
* @link http://maslosoft.com/staple/
*/
namespace Maslosoft\Staple\Processors\Pre;
use Closure;
use Maslosoft\Staple\Interfaces\PreProcessorInterface;
use Maslosoft\Staple\Interfaces\RendererAwareInterface;
/**
* ##Callback Extractor##
*
* This can be used to pass data from other php scripts.
*
* By default Callback Extractor is disabled, as it need to have configured
* callback to do anything.
*
* Example configuration with anonymous function:
* ```php
* $staple->preProcessors[] = [
* 'class' => CallbackExtractor::class,
* 'callback' => function($owner, $filename, $view){
* return ['message' => 'Hello World!']
* }
* ];
* ```
* This will result in variable `$data->message` available in both view and template.
*
* Multiple Callback Extractors can be used to call different callbacks.
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class CallbackExtractor implements PreProcessorInterface
{
/**
* Callback for getting data.
*
* This will be called with same arguments as `getData` method:
* ```php
* RendererAwareInterface $owner
* string $filename
* string$view
* ```
*
* It must return array, prefably associative, as it will be merged with other extractors data
* @var Closure
*/
public $callback = null;
public function decorate(RendererAwareInterface $owner, &$content, $data)
{
}
public function getData(RendererAwareInterface $owner, $filename, $view)
{
if (null !== $this->callback)
{
return call_user_func_array($this->callback, func_get_args());
}
return [];
}
}
API documentation generated by ApiGen