Printful\GettextCms\Structures\ScanItem

Complexity

Total Complexity

1

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1

<?php

namespace Printful\GettextCms\Structures;

/**
 * Class represents configuration for scanning a directory or a single file for translation messages
 */
class ScanItem
{
    /**
     * Path to a directory or a file to scan
     * @var string
     */
    public $path;

    /**
     * File extensions to scan.
     * Missing value means all supported files will be scanned.
     *
     * @var string[]
     */
    public $extensions = null;

    /**
     * List of functions to scan for
     * Format is: [ custom-function => gettext-function, ..]
     * For example: [translate => gettext, translatePlural => ngettext]
     *
     * Default values can be found here, for example:
     * @see \Gettext\Extractors\JsCode::$options
     * @see \Gettext\Extractors\PhpCode::$options
     *
     * @var array If null, we use default functions from Gettext library (standard gettext functions)
     */
    public $functions = null;

    /**
     * Scan directory recursively
     * @var bool
     */
    public $recursive;

    /**
     * @param string $path Path to a directory or a file to scan
     * @param array $extensions List of extensions to scan for
     * @param bool $recursive Scan directory recursively
     * @param array|null $functions Functions that should be scanned for additionally, format: [customFunction => gettext|dgettext|..]]
     *
     * @see ScanItem::$functions
     */
    public function __construct($path, array $extensions = null, $recursive = true, array $functions = null)
    {
        $this->path = $path;
        $this->extensions = $extensions;
        $this->recursive = $recursive;
        $this->functions = $functions;
    }
}