mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-10 16:35:35 +02:00
Code Issues Releases Wiki Activity

[ticket/13807] Add an option to generate a diff for the release highlights

Browse Source 
PHPBB3-13807
This commit is contained in:
Joas Schilling 2015-05-02 14:33:31 +02:00
parent bdad879508
commit 96d97ae2d2
3 changed files with 68 additions and 14 deletions

47
phpBB/develop/export_events_for_wiki.php

@ -28,6 +28,9 @@ function usage()
echo " all:\n";
echo " Generate the complete wikipage for https://wiki.phpbb.com/Event_List\n";
echo "\n";
echo " diff:\n";
echo " Generate the Event Diff for the release highlights\n";
echo "\n";
echo " php:\n";
echo " Generate the PHP event section of Event_List\n";
echo "\n";
@ -37,6 +40,9 @@ function usage()
echo " styles:\n";
echo " Generate the Styles Template event section of Event_List\n";
echo "\n";
echo "VERSION (diff only):\n";
echo " Filter events (minimum version)\n";
echo "\n";
echo "EXTENSION (Optional):\n";
echo " If not given, only core events will be exported.\n";
echo " Otherwise only events from the extension will be exported.\n";
@ -55,8 +61,8 @@ function validate_argument_count($arguments, $count)
validate_argument_count($argc, 1);
$action = $argv[1];
$extension = isset($argv[2]) && $argv[2] !== 'null' ? $argv[2] : null;
$min_version = isset($argv[3]) ? $argv[3] : null;
$extension = isset($argv[2]) ? $argv[2] : null;
$min_version = null;
require __DIR__ . '/../phpbb/event/php_exporter.' . $phpEx;
require __DIR__ . '/../phpbb/event/md_exporter.' . $phpEx;
require __DIR__ . '/../includes/functions.' . $phpEx;
@ -68,10 +74,19 @@ switch ($action)
case 'all':
echo '__FORCETOC__' . "\n";
case 'diff':
if ($action === 'diff')
{
echo '== Event changes ==' . "\n";
}
$min_version = $extension;
$extension = isset($argv[3]) ? $argv[3] : null;
case 'php':
$exporter = new \phpbb\event\php_exporter($phpbb_root_path, $extension, $min_version);
$exporter->crawl_phpbb_directory_php();
echo $exporter->export_events_for_wiki();
echo $exporter->export_events_for_wiki($action);
if ($action === 'php')
{
@ -81,9 +96,16 @@ switch ($action)
// no break;
case 'styles':
$exporter = new \phpbb\event\md_exporter($phpbb_root_path, $extension);
$exporter->crawl_phpbb_directory_styles('docs/events.md');
echo $exporter->export_events_for_wiki();
$exporter = new \phpbb\event\md_exporter($phpbb_root_path, $extension, $min_version);
if ($min_version && $action === 'diff')
{
$exporter->crawl_eventsmd('docs/events.md', 'styles');
}
else
{
$exporter->crawl_phpbb_directory_styles('docs/events.md');
}
echo $exporter->export_events_for_wiki($action);
if ($action === 'styles')
{
@ -93,9 +115,16 @@ switch ($action)
// no break;
case 'adm':
$exporter = new \phpbb\event\md_exporter($phpbb_root_path, $extension);
$exporter->crawl_phpbb_directory_adm('docs/events.md');
echo $exporter->export_events_for_wiki();
$exporter = new \phpbb\event\md_exporter($phpbb_root_path, $extension, $min_version);
if ($min_version && $action === 'diff')
{
$exporter->crawl_eventsmd('docs/events.md', 'adm');
}
else
{
$exporter->crawl_phpbb_directory_adm('docs/events.md');
}
echo $exporter->export_events_for_wiki($action);
if ($action === 'all')
{

22
phpBB/phpbb/event/md_exporter.php

@ -191,19 +191,35 @@ class md_exporter
/**
* Format the php events as a wiki table
*
* @param string $action
* @return string Number of events found
*/
public function export_events_for_wiki()
public function export_events_for_wiki($action = '')
{
if ($this->filter === 'adm')
{
$wiki_page = '= ACP Template Events =' . "\n";
if ($action === 'diff')
{
$wiki_page = '=== ACP Template Events ===' . "\n";
}
else
{
$wiki_page = '= ACP Template Events =' . "\n";
}
$wiki_page .= '{| class="zebra sortable" cellspacing="0" cellpadding="5"' . "\n";
$wiki_page .= '! Identifier !! Placement !! Added in Release !! Explanation' . "\n";
}
else
{
$wiki_page = '= Template Events =' . "\n";
if ($action === 'diff')
{
$wiki_page = '=== Template Events ===' . "\n";
}
else
{
$wiki_page = '= Template Events =' . "\n";
}
$wiki_page .= '{| class="zebra sortable" cellspacing="0" cellpadding="5"' . "\n";
$wiki_page .= '! Identifier !! Prosilver Placement (If applicable) !! Subsilver Placement (If applicable) !! Added in Release !! Explanation' . "\n";
}

13
phpBB/phpbb/event/php_exporter.php

@ -158,11 +158,20 @@ class php_exporter
/**
* Format the php events as a wiki table
*
* @param string $action
* @return string
*/
public function export_events_for_wiki()
public function export_events_for_wiki($action = '')
{
$wiki_page = '= PHP Events (Hook Locations) =' . "\n";
if ($action === 'diff')
{
$wiki_page = '=== PHP Events (Hook Locations) ===' . "\n";
}
else
{
$wiki_page = '= PHP Events (Hook Locations) =' . "\n";
}
$wiki_page .= '{| class="sortable zebra" cellspacing="0" cellpadding="5"' . "\n";
$wiki_page .= '! Identifier !! Placement !! Arguments !! Added in Release !! Explanation' . "\n";
foreach ($this->events as $event)