Comments extraction from PHP code

[mlocati]

Follow-up of #100: what about a code like this?

[mlocati]

Let's filter out white spaces, so that parsing tokens is faster

[oscarotero]

It looks fine. I think is better to extract always the comments. If the user don't want them, they can be removed later. The rest of the extractors are not configurable. What do you think?

[mlocati]

One may want only comments that start with a specific text (like xgettext), otherwise we risk to extract comments that are not related to the strings to be translated.
Think for instance at this example:

// Initialize some variables
$hi = __('Hello');
$x = 1;
$y = 2;

So, I think we should keep the same approach as xgettext: only extract comments if requested, and optionally allow to specify a "tag" to filter comments to be extracted.

[oscarotero]

ah, so comments can be before the function, not neccesary inside?
Ok, in this case, maybe a static property (like public static $functions) ?

[mlocati]

Something like https://github.com/mlocati/Gettext/commit/26c3b5302640be451a589e9cff8bc35e8d70b217 ?

[oscarotero]

Its fine to me

[mlocati]

I forgot to answer this:

ah, so comments can be before the function, not neccesary inside?

Yes, xgettext can extract comments that are imediately before the function, provided that "comment blocks supposed to be extracted must be adjacent to keyword lines" (from gettext manual)

That means that with this code

<?php

echo __(/* i18n: Test comment 1 */'test 1');

/* i18n: Test comment 2 */
echo __('test 2');

/* i18n: Test comment 3 */

echo __('test 3');

/* i18n: Test comment 4 */
echo __(
    'test 4'
);

xgettext extracts comments 1, 2 and 3, but not the 4th:

#. i18n: Test comment 1
#: test.php:3
msgid "test 1"
msgstr ""

#. i18n: Test comment 2
#: test.php:6
msgid "test 2"
msgstr ""

#. i18n: Test comment 3
#: test.php:10
msgid "test 3"
msgstr ""

#: test.php:14
msgid "test 4"
msgstr ""

The current implementation of this pull request is a bit different: it will extracts also i18n: Test comment 4, but I don't think this will be a big problem.

[mlocati]

Ok, I'll add a few tests and everything is ready to be merged 😉

[mlocati]

Done.

[mlocati]

After this has been merged I'll stop boring you and I'll be looking forward to a new release 😉

[oscarotero]

Thanks for your hard work. I'm going to release the new 3.5.9 version soon.

[mlocati]

Thanks for your hard work.

Thanks to you!

I'm going to release the new 3.5.9 version soon.

Great!

[oscarotero]

The wait is over: https://github.com/oscarotero/Gettext/releases/tag/v3.5.9

[mlocati]

Super fast! Thank you!!