Gettext\Extractors\Extractor Class Reference

Inheritance diagram for Gettext\Extractors\Extractor:

Collaboration diagram for Gettext\Extractors\Extractor:

Static Public Member Functions
static	fromFile ($file, Translations $translations=null)
	Extract the translations from a file. More...

Static Protected Member Functions
static	getFiles ($file)
	Checks and returns all files. More...
static	readFile ($file)
	Reads and returns the content of a file. More...

Detailed Description

Definition at line 9 of file Extractor.php.

Member Function Documentation

fromFile()

static Gettext\Extractors\Extractor::fromFile (   $file, Translations  $translations = null  )

static

Extract the translations from a file.

Parameters

array | string	$file	A path of a file or files
null | Translations	$translations	The translations instance to append the new translations.

Returns

Translations

Reimplemented in Gettext\Extractors\PhpArray.

Definition at line 19 of file Extractor.php.

    {
        if ($translations === null) {
            $translations = new Translations();
        }
 
        foreach (self::getFiles($file) as $file) {
            static::fromString(self::readFile($file), $translations, $file);
        }
 
        return $translations;
    }

getFiles()

static Gettext\Extractors\Extractor::getFiles (   $file )

staticprotected

Checks and returns all files.

Parameters

string | array

$file

The file/s

Returns

array The file paths

Definition at line 39 of file Extractor.php.

    {
        if (empty($file)) {
            throw new InvalidArgumentException('There is not any file defined');
        }
 
        if (is_string($file)) {
            if (!is_file($file)) {
                throw new InvalidArgumentException("'$file' is not a valid file");
            }
 
            if (!is_readable($file)) {
                throw new InvalidArgumentException("'$file' is not a readable file");
            }
 
            return array($file);
        }
 
        if (is_array($file)) {
            $files = array();
 
            foreach ($file as $f) {
                $files = array_merge($files, self::getFiles($f));
            }
 
            return $files;
        }
 
        throw new InvalidArgumentException('The first argumet must be string or array');
    }

References $f, and $files.

readFile()

static Gettext\Extractors\Extractor::readFile (   $file )

staticprotected

Reads and returns the content of a file.

Parameters

string

$file

Returns

string

Definition at line 77 of file Extractor.php.

    {
        $length = filesize($file);
 
        if (!($fd = fopen($file, 'rb'))) {
            throw new Exception("Cannot read the file '$file', probably permissions");
        }
 
        $content = $length ? fread($fd, $length) : '';
        fclose($fd);
 
        return $content;
    }

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/gettext/gettext/src/Extractors/Extractor.php