aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/event/php_exporter.php
diff options
context:
space:
mode:
authorJoas Schilling <nickvergessen@gmx.de>2014-04-26 16:30:19 +0200
committerJoas Schilling <nickvergessen@gmx.de>2014-04-26 16:39:53 +0200
commit6aa8596d4dc206797e4740465e3035c65bcdba3f (patch)
treefc3530942eda5d4c420c334d6a6540ad07cc8462 /phpBB/phpbb/event/php_exporter.php
parent18be18e9989dcd48b662c5bb2bd128ca947f68d3 (diff)
downloadforums-6aa8596d4dc206797e4740465e3035c65bcdba3f.tar
forums-6aa8596d4dc206797e4740465e3035c65bcdba3f.tar.gz
forums-6aa8596d4dc206797e4740465e3035c65bcdba3f.tar.bz2
forums-6aa8596d4dc206797e4740465e3035c65bcdba3f.tar.xz
forums-6aa8596d4dc206797e4740465e3035c65bcdba3f.zip
[ticket/12273] Fix doc blocks
PHPBB3-12273
Diffstat (limited to 'phpBB/phpbb/event/php_exporter.php')
-rw-r--r--phpBB/phpbb/event/php_exporter.php21
1 files changed, 20 insertions, 1 deletions
diff --git a/phpBB/phpbb/event/php_exporter.php b/phpBB/phpbb/event/php_exporter.php
index a92bd2671d..41058216e8 100644
--- a/phpBB/phpbb/event/php_exporter.php
+++ b/phpBB/phpbb/event/php_exporter.php
@@ -46,17 +46,35 @@ class php_exporter
$this->current_event_line = 0;
}
+ /**
+ * Get the list of all events
+ *
+ * @return array Array with events: name => details
+ */
public function get_events()
{
return $this->events;
}
+ /**
+ * Set current event data
+ *
+ * @param string $name Name of the current event (used for error messages)
+ * @param int $line Line where the current event is placed in
+ * @return null
+ */
public function set_current_event($name, $line)
{
$this->current_event = $name;
$this->current_event_line = $line;
}
+ /**
+ * Set the content of this file
+ *
+ * @param array $content Array with the lines of the file
+ * @return null
+ */
public function set_content($content)
{
$this->file_lines = $content;
@@ -322,6 +340,8 @@ class php_exporter
* Find the variables in single line array
*
* @param string $line
+ * @param bool $throw_multiline Throw an exception when there are too
+ * many arguments in one line.
* @return array List of variables
* @throws \LogicException
*/
@@ -349,7 +369,6 @@ class php_exporter
/**
* Find the variables in single line array
*
- * @param string $line
* @return array List of variables
* @throws \LogicException
*/