Is it just me or doesnt the comment extraction work with the new version? With the old version I think there was enableCommentsExtraction. With the new version there is no such method and the extraction also doesn't happen automatically it seems. I use this code for testing:

$translations=Translations::create();
$phpScanner=new PhpScanner($translations);
$php=<<<PHP
<?php
//I love comment extraction
echo gettext('hello world');
PHP;
$phpScanner->scanString($php,"hello.php");
print_r($translations);
exit;

$translation->extractedComments seems to be empty.

This feature was very useful for parsing the PHP compiled from Twig template files, because the compiled PHP code included the original line number in the Twig file so you get a kind of source-map feature where you can see where the real line of the respective translation was...

The scanner does not add the php-format flag for gettext() arguments that are a format string for sprintf() functions such as %s or %d. For example: sprintf(gettext("This is %s"), $value); does not return flag #, php-format

Trying to leverage the comment extraction functionality of the PhpScanner class. I am having a hard time getting anything except in the simplest of cases.
Working:

//Translators: foo
gettext('bar');
//Translators: bar
echo gettext('foo');

Not Working:

//Translators: foo
$foo = gettext('foo');
//Translators: bar
$bar = sprintf(_('bar %s', 'foo'));

In the process of trying to upgrade from php-gettext version 4.x to 5.x in my code, and the following example code:

<?php
$var = __(
  'Test string. This is a very long string, so I want to wrap it across '
  . 'multiple lines.'
);

Yields the error:

Invalid gettext function in (file). Some required arguments are not valid

I believe this is because the parser isn't correctly handling the multiline string inside the function call.

I'm getting the following error:

PHP Fatal error:  Uncaught Error: Call to undefined method PhpParser\Node\Expr\Variable::getLast() in .../vendor/gettext/php-scanner/src/PhpNodeVisitor.php:31

the line of code triggering the error is:

    $phpScanner->scanFile($file->getRelativePathname());

the contents of the file which would still trigger the error

<?php

class AuthMiddleware
{
    public function test()
    {
       return __('Accessing the Backoffice is not allowed at this time.');
    }
}

Versions:

gettext/gettext                     v5.0.0             PHP gettext manager
gettext/languages                   2.5.0              gettext languages with plural rules
gettext/php-scanner                 v1.0.0             PHP scanner for gettext

Currently there is: default: $function->addArgument(); So, if the argument is not Scalar_String, Scalar_LNumber or Scalar_DNumber then the argument is silently discarded. It would be very helpful if the class could at least call an empty protected method so that a child class can then decide what happens with that argument without completely overriding createFunction(). Drupal has the following syntax to supply context info: t("Translatable string","",["context"=>"Context string"]); Unfortunately the array type in the 3rd argument is discarded and there's no easy way to get to it even in a child class.

adding to tests/assets/code.php will trigger this case:

__(ucfirst('test'));

While it seems logical that the scanner can't index this line, a warning/notice is a lot better. Because this exception is not catched internally, it's impossible to ignore it and continue the rest of the file, we add the translations like this manually to the translation file. This works in the previous version of php-gettext

Hello

I have the following po file contents, resulting from a scan for php files:

msgid ""
msgstr ""
"X-Domain: messages\n"

#: /var/www/html/the_site/_teste.php:41
msgid "dah"
msgstr ""

I have the following code to scan for files:

/*considering the following folder structure:
vendor
    /my_plugins
        /module1
        /module2
*/
$LOCALES = ["en" => "en_GB","pt" => "pt_PT"];

$folders= new DirectoryIterator("vendor/my_plugins");

foreach($folders as $folder) {

    $path = $folder->getFilename();
    
    $DOMAIN = "module1"; //in my actual code, domain takes several different names depending on the folder the iterator is working on
    
    $destination_folder = $folder->getPathname()."/locale/"; //will save in vendor/my_plugins/module1/locale
    
    foreach($LOCALES as $code => $locale) {
    
            if (!file_exists($destination_folder) || !file_exists($destination_folder.$locale)) {
                    //folder creation
                    mkdir($destination_folder.$locale,0777,true);
                    
            }
    }
    
     foreach(LOCALES as $codigo => $locale) {
     
         $phpScanner = new PhpScanner(
             Translations::create($DOMAIN)
          );
          $phpScanner->setDefaultDomain($DOMAIN);
          //resulting PO file matches $DOMAIN
          
          $phpScanner->scanFile("some_file.php");  //this also works
          
          //done scanning, let's go to generate files
          $FILE = $destination_folder.$locale."/".$DOMAIN.".po";
          
          $po_generator = new PoGenerator();
          $mo_generator = new MoGenerator();
          
          foreach ($phpScanner->getTranslations() as $domain => $translations) {
                  //line below raises: Fatal error: Uncaught Error: Call to undefined method Gettext\Translations::setHeader() in
                  $translations->setHeader("Content-Type", "text/plain; charset=UTF-8");

                  //seems to work, but po file does not seem to have the "language" header
                  $translations->setLanguage($locale); //should be pt_PT or pt_PT.utf8 ( the latter is installed in my system )

                  $po_generator->generateFile($translations, $FILE);
          }
     }
     

What is the proper way to set headers in the file, using PHP-Scanner? Should I load it again with Loader and the set the headers it, and finally generate the mo file?

I'm not sure, maybe this issue should be submitted to nikic/php-parser repo instead. I use own Translator helper class with static methods and I cannot extract messages from it method invocations.

Translator helper class:

use Gettext\Loader\PoLoader;
use Gettext\Translation;

final class Translator
{
    /** @var Gettext\Loader\LoaderInterface|null */
    protected static $loader;

    /** @var Gettext\Translations|null */
    protected static $translations;

    /**
     * Loads translations from PO file with php/gettext package.
     * @ref https://github.com/php-gettext/Gettext
     *
     * @param string $filePath Path to PO file
     */
    public static function loadPo(string $filePath)
    {
        if (!static::$loader) {
            static::$loader = new PoLoader();
        }
        static::$translations = static::$loader->loadFile($filePath);
    }

    /**
     * Translates message.
     *
     * @param string $msg Original message
     *
     * @return string Localized message or original if doesn't exist in PO file
     */
    public static function translate(string $msg): string
    {
        $t = static::$translations->find(null, $msg);
        if (
            $t instanceof Translation
            && $t->isTranslated()
        ) {
            return $t->getTranslation();
        }

        return $msg;
    }
}

scanner configuration:

//Create a new scanner, adding a translation for each domain we want to get:
$phpScanner = new PhpScanner(
    Translations::create('domain')
);

$phpScanner->setFunctions(
    array_merge(
        $phpScanner->getFunctions(),
        // none of following works
        ['Translator::translate' => 'gettext'],
        ['::translate' => 'gettext'],
        ['translate' => 'gettext']
    )
);

scanned file example:

Translator::loadPo('../locale/en/LC_MESSAGES/domain.po');
// i18n: 'Hello World' should be extracted
$msg = Translator::translate('Hello World');
echo $msg;

// po file saving omitted

Hi, im using gettext/gettext with this php-scanner but when use the scanner: $scanner->scanFile($file); $translations = $scanner->getTranslations(); but never find translations, the $file have __('text') inside. I have initialized the Scanner like: $scanner = new PhpScanner(); $scanner->setDefaultDomain('domain1'); Any suggestions? Thanks in advance