Comment extraction does not work when placed on the line above within array (or what)

[jasomdotnet]

Hi Oscar,

this is the case, comment extraction does not work:

<?php
require 'vendor/autoload.php';

use Gettext\Scanner\PhpScanner;
use Gettext\Translations;

$phpScanner = new PhpScanner(
        Translations::create('default'),
        Translations::create('admin'),
);

$phpScanner->setFunctions([
    '__' => 'gettext',
    'd__' => 'dgettext',
]);

$phpScanner->ignoreInvalidFunctions(true);
$phpScanner->setDefaultDomain('default');
$phpScanner->extractCommentsStartingWith('PREV:', 'Prev:', 'prev:');
$phpScanner->scanFile('class.php');

echo '<pre>' . PHP_EOL;
print_r($phpScanner->getTranslations());

And this is the class.php

<?php
/* PREV: Extracted comment 1 */
$arg = [__('String with extracted comment 1')];

$args = [];

$args = array_merge($args, [
    'title' => /* PREV: Extracted comment 2 */ __('Contact'),
    'noscript' => [
        /* PREV: Omitted commnet above 1  */
        Flash::INFO => [__('String with no comment extracted despite it has one.')]
    ],
    'breadcrumb' => [
        ['text' => /* PREV: Extracted comment 3 */ d__('admin', 'String with extracted comment 3'), 'link' => get_homepage_url()],
    ],
    'metatags' => new Meta([
        /* PREV: Omitted commnet above 2 */
        'description' => __('Another string with no comment extracted despite it has one.'),
            ]),
        ]
);

Is this a bug or am I doing something wrong?

NOTE: PREV in this case means "previous original"

[oscarotero]

It looks like a bug. I'm not sure yet how to fix it.
The PHP parser automatically assign some comments to functions (here: https://github.com/php-gettext/PHP-Scanner/blob/master/src/PhpNodeVisitor.php#L89)
And I'm using the bufferComments array to collect other comments not automatically assigned to functions but they are in the same line (here: https://github.com/php-gettext/PHP-Scanner/blob/master/src/PhpNodeVisitor.php#L93)

But assigning comments defined in the previous line is not always correct (there may be also a function in the previous line).

Unfortunately I don't have free time for this. Do you like to work on a pull request?

[jasomdotnet]

Thanks for a fast reply.

Comments in the code are crucial for translation because it's a way how to leave "context" info for machine translation and info about previous original.

I'm using comments in the previous line because (the code reads better and) PHP-Scanner has problem to extract all "inline" comments too.

Based on your last sentence

Unfortunately I don't have free time for this. Do you like to work on a pull request?

I will try to fix it, despite have no clue how :D Don't know when.