1
0
mirror of https://github.com/phpbb/phpbb.git synced 2025-02-22 19:07:27 +01:00

[ticket/11768] Renamed service vars

The name of the variable that holds the service instance is now consistent
across events.

PHPBB3-11768
This commit is contained in:
JoshyPHP 2015-03-27 01:29:09 +01:00
parent 3e04e643df
commit d8e7e11ee3
4 changed files with 26 additions and 32 deletions

View File

@ -57,7 +57,7 @@ class parser implements \phpbb\textformatter\parser_interface
$this->dispatcher = $dispatcher;
$this->parser = $parser;
$this->user = $user;
$self = $this;
$parser = $this;
/**
* Configure the parser service
@ -69,12 +69,11 @@ class parser implements \phpbb\textformatter\parser_interface
* - configure the s9e\TextFormatter parser
*
* @event core.text_formatter_s9e_parser_setup
* @var \s9e\TextFormatter\Parser parser s9e\TextFormatter parser instance
* @var \phpbb\textformatter\s9e\parser self This parser service
* @var \phpbb\textformatter\s9e\parser parser This parser service
* @var \phpbb\user user Current user
* @since 3.2.0-a1
*/
$vars = array('parser', 'self', 'user');
$vars = array('parser', 'user');
extract($dispatcher->trigger_event('core.text_formatter_s9e_parser_setup', compact($vars)));
}
@ -83,17 +82,17 @@ class parser implements \phpbb\textformatter\parser_interface
*/
public function parse($text)
{
$self = $this;
$parser = $this;
/**
* Modify a text before it is parsed
*
* @event core.text_formatter_s9e_parse_before
* @var \phpbb\textformatter\s9e\parser self This parser service
* @var \phpbb\textformatter\s9e\parser parser This parser service
* @var string text The original text
* @since 3.2.0-a1
*/
$vars = array('self', 'text');
$vars = array('parser', 'text');
extract($this->dispatcher->trigger_event('core.text_formatter_s9e_parse_before', compact($vars)));
$xml = $this->parser->parse($text);
@ -102,11 +101,11 @@ class parser implements \phpbb\textformatter\parser_interface
* Modify a parsed text in its XML form
*
* @event core.text_formatter_s9e_parse_after
* @var \phpbb\textformatter\s9e\parser self This parser service
* @var \phpbb\textformatter\s9e\parser parser This parser service
* @var string xml The parsed text, in XML
* @since 3.2.0-a1
*/
$vars = array('self', 'xml');
$vars = array('parser', 'xml');
extract($this->dispatcher->trigger_event('core.text_formatter_s9e_parse_after', compact($vars)));
return $xml;

View File

@ -99,17 +99,16 @@ class renderer implements \phpbb\textformatter\renderer_interface
}
$this->dispatcher = $dispatcher;
$this->renderer = $renderer;
$self = $this;
$renderer = $this;
/**
* Configure the renderer service
*
* @event core.text_formatter_s9e_renderer_setup
* @var \s9e\TextFormatter\Renderer renderer s9e\TextFormatter renderer instance
* @var \phpbb\textformatter\s9e\renderer self This renderer service
* @var \phpbb\textformatter\s9e\renderer renderer This renderer service
* @since 3.2.0-a1
*/
$vars = array('renderer', 'self');
$vars = array('renderer');
extract($dispatcher->trigger_event('core.text_formatter_s9e_renderer_setup', compact($vars)));
}
@ -210,17 +209,17 @@ class renderer implements \phpbb\textformatter\renderer_interface
*/
public function render($xml)
{
$self = $this;
$renderer = $this;
/**
* Modify a parsed text before it is rendered
*
* @event core.text_formatter_s9e_render_before
* @var \phpbb\textformatter\s9e\renderer self This renderer service
* @var \phpbb\textformatter\s9e\renderer renderer This renderer service
* @var string xml The parsed text, in its XML form
* @since 3.2.0-a1
*/
$vars = array('self', 'xml');
$vars = array('renderer', 'xml');
extract($this->dispatcher->trigger_event('core.text_formatter_s9e_render_before', compact($vars)));
if (isset($this->censor) && $this->viewcensors)
@ -267,10 +266,10 @@ class renderer implements \phpbb\textformatter\renderer_interface
*
* @event core.text_formatter_s9e_render_after
* @var string html The rendered text's HTML
* @var \phpbb\textformatter\s9e\renderer self This renderer service
* @var \phpbb\textformatter\s9e\renderer renderer This renderer service
* @since 3.2.0-a1
*/
$vars = array('html', 'self');
$vars = array('html', 'renderer');
extract($this->dispatcher->trigger_event('core.text_formatter_s9e_render_after', compact($vars)));
return $html;

View File

@ -200,9 +200,7 @@ class phpbb_textformatter_s9e_parser_test extends phpbb_test_case
public function setup_event_callback($vars)
{
return isset($vars['parser'])
&& $vars['parser'] instanceof \s9e\TextFormatter\Parser
&& isset($vars['self'])
&& $vars['self'] instanceof \phpbb\textformatter\s9e\parser
&& $vars['parser'] instanceof \phpbb\textformatter\s9e\parser
&& isset($vars['user'])
&& $vars['user'] instanceof \phpbb\user;
}
@ -247,16 +245,16 @@ class phpbb_textformatter_s9e_parser_test extends phpbb_test_case
public function parse_before_event_callback($vars)
{
return isset($vars['self'])
&& $vars['self'] instanceof \phpbb\textformatter\s9e\parser
return isset($vars['parser'])
&& $vars['parser'] instanceof \phpbb\textformatter\s9e\parser
&& isset($vars['text'])
&& $vars['text'] === '...';
}
public function parse_after_event_callback($vars)
{
return isset($vars['self'])
&& $vars['self'] instanceof \phpbb\textformatter\s9e\parser
return isset($vars['parser'])
&& $vars['parser'] instanceof \phpbb\textformatter\s9e\parser
&& isset($vars['xml'])
&& $vars['xml'] === '<t>...</t>';
}

View File

@ -385,9 +385,7 @@ class phpbb_textformatter_s9e_renderer_test extends phpbb_test_case
public function setup_event_callback($vars)
{
return isset($vars['renderer'])
&& $vars['renderer'] instanceof \s9e\TextFormatter\Renderer
&& isset($vars['self'])
&& $vars['self'] instanceof \phpbb\textformatter\s9e\renderer;
&& $vars['renderer'] instanceof \phpbb\textformatter\s9e\renderer;
}
/**
@ -430,8 +428,8 @@ class phpbb_textformatter_s9e_renderer_test extends phpbb_test_case
public function render_before_event_callback($vars)
{
return isset($vars['self'])
&& $vars['self'] instanceof \phpbb\textformatter\s9e\renderer
return isset($vars['renderer'])
&& $vars['renderer'] instanceof \phpbb\textformatter\s9e\renderer
&& isset($vars['xml'])
&& $vars['xml'] === '<t>...</t>';
}
@ -440,8 +438,8 @@ class phpbb_textformatter_s9e_renderer_test extends phpbb_test_case
{
return isset($vars['html'])
&& $vars['html'] === '...'
&& isset($vars['self'])
&& $vars['self'] instanceof \phpbb\textformatter\s9e\renderer;
&& isset($vars['renderer'])
&& $vars['renderer'] instanceof \phpbb\textformatter\s9e\renderer;
}
public function test_get_renderer()