1C-Bitrix 25.700.0
Загрузка...
Поиск...
Не найдено
Класс ExportAction
Граф наследования:ExportAction:
Action Action Errorable ExportFile ExportFileList ExportFileSearch ExportPath ExportPhraseSearch

Открытые члены

 __construct ($name, Main\Engine\Controller $controller, array $config=[])
 getDownloadingParameters ()
 getDownloadingSamplesParameters ()
 mergeLangFiles (string $langFilePath, array $fullLangFilePaths, bool $collectUntranslated=false, array $filterByCodeList=[])
 lookThroughLangFolder (string $langPath)
Открытые члены унаследованные от Action
 hasErrors ()
Открытые члены унаследованные от Action
 __construct ($name, Controller $controller, $config=array())
 configure ($params)
 getArguments ()
 setArguments (array $arguments)
 runWithSourceParametersList ()
 getBinder ()
 getController ()
 getName ()
 getConfig ()
 getCurrentUser ()
 convertKeysToCamelCase ($data)
 getErrors ()
 getErrorByCode ($code)

Защищенные члены

 configureExportCsvFile (Translate\IO\CsvFile $csvFile)
 generateExportFileName (string $path, array $languages)
 getFullPath (int $pathId)
Защищенные члены унаследованные от Action
 init ()
 buildBinder ()
 onBeforeRun ()
 onAfterRun ()
 addError (Error $error)
 addErrors (array $errors)

Защищенные данные

int $tabId = 0
string $exportFilePath = ''
string $exportFileName = ''
string $exportFileType = 'application/csv'
int $exportFileSize = 0
bool $convertEncoding
string $encodingOut
bool $collectUntranslated
bool $appendSamples = false
int $samplesCount = 10
array $samplesRestriction = []
string $samplesFilePath = ''
string $samplesFileName = ''
int $samplesFileSize = 0
int $maxSampleSourceLength = 500
array $languages = []
int $exportedPhraseCount = 0
int $exportedSamplesCount = 0
Translate Filter $filter
array $fullPathCache = []
Защищенные данные унаследованные от Action
 $binder
 $errorCollection
 $controller
 $config
 $name

Статические защищенные данные

static string $documentRoot = ''
static bool $useTranslationRepository = false
static array $translationRepositoryLanguages = []

Дополнительные унаследованные члены

Открытые статические члены унаследованные от Action
static className ()

Подробное описание

Harvester of the lang files disposition.

@method array run(string $path, bool $runBefore)

См. определение в файле exportaction.php строка 15

Конструктор(ы)

◆ __construct()

__construct ( $name,
Main\Engine\Controller $controller,
array $config = [] )

\Bitrix\Main\Engine\Action constructor.

Аргументы
string$nameAction name.
Main\Engine\Controller$controllerParent controller object.
array$configAdditional configuration.

Переопределяется в ExportFile, ExportFileList, ExportFileSearch, ExportPath и ExportPhraseSearch.

См. определение в файле exportaction.php строка 66

Методы

◆ configureExportCsvFile()

configureExportCsvFile ( Translate\IO\CsvFile $csvFile)
protected

Apply module configuration to exporting csv file.

Аргументы
Translate\IO\CsvFile$csvFileObject to configure.
Возвращает
void

См. определение в файле exportaction.php строка 196

◆ generateExportFileName()

generateExportFileName ( string $path,
array $languages )
protected

Generate name for exporting file.

Аргументы
string$pathExporting path.
string[]$languagesList of exporting languages.
Возвращает
string

См. определение в файле exportaction.php строка 225

◆ getDownloadingParameters()

getDownloadingParameters ( )

Returns exported file properties.

Возвращает
array

См. определение в файле exportaction.php строка 235

◆ getDownloadingSamplesParameters()

getDownloadingSamplesParameters ( )

Returns exported file properties.

Возвращает
array

См. определение в файле exportaction.php строка 250

◆ getFullPath()

getFullPath ( int $pathId)
protected

Returns list of full paths for lang path.

Аргументы
int$pathId
Возвращает
array

См. определение в файле exportaction.php строка 553

◆ lookThroughLangFolder()

lookThroughLangFolder ( string $langPath)

Runs through lang folder and collects full path to lang files.

Аргументы
string$langPathRelative project path of the language folder.
Возвращает
\Generator|array|iterable

См. определение в файле exportaction.php строка 378

◆ mergeLangFiles()

mergeLangFiles ( string $langFilePath,
array $fullLangFilePaths,
bool $collectUntranslated = false,
array $filterByCodeList = [] )

Merges all language files into one array.

Аргументы
string$langFilePathRelative project path of the language file.
string[]$fullLangFilePathsArray of full paths to lang files.
bool$collectUntranslatedCollect only untranslated phrases.
string[]$filterByCodeListArray of prase codes to filter.
Возвращает
array

См. определение в файле exportaction.php строка 270

Поля

◆ $appendSamples

bool $appendSamples = false
protected

См. определение в файле exportaction.php строка 37

◆ $collectUntranslated

bool $collectUntranslated
protected

См. определение в файле exportaction.php строка 34

◆ $convertEncoding

bool $convertEncoding
protected

См. определение в файле exportaction.php строка 30

◆ $documentRoot

string $documentRoot = ''
staticprotected

См. определение в файле exportaction.php строка 17

◆ $encodingOut

string $encodingOut
protected

См. определение в файле exportaction.php строка 32

◆ $exportedPhraseCount

int $exportedPhraseCount = 0
protected

См. определение в файле exportaction.php строка 50

◆ $exportedSamplesCount

int $exportedSamplesCount = 0
protected

См. определение в файле exportaction.php строка 52

◆ $exportFileName

string $exportFileName = ''
protected

См. определение в файле exportaction.php строка 26

◆ $exportFilePath

string $exportFilePath = ''
protected

См. определение в файле exportaction.php строка 25

◆ $exportFileSize

int $exportFileSize = 0
protected

См. определение в файле exportaction.php строка 28

◆ $exportFileType

string $exportFileType = 'application/csv'
protected

См. определение в файле exportaction.php строка 27

◆ $filter

Translate Filter $filter
protected

См. определение в файле exportaction.php строка 54

◆ $fullPathCache

array $fullPathCache = []
protected

См. определение в файле exportaction.php строка 56

◆ $languages

array $languages = []
protected

См. определение в файле exportaction.php строка 48

◆ $maxSampleSourceLength

int $maxSampleSourceLength = 500
protected

См. определение в файле exportaction.php строка 45

◆ $samplesCount

int $samplesCount = 10
protected

См. определение в файле exportaction.php строка 38

◆ $samplesFileName

string $samplesFileName = ''
protected

См. определение в файле exportaction.php строка 41

◆ $samplesFilePath

string $samplesFilePath = ''
protected

См. определение в файле exportaction.php строка 40

◆ $samplesFileSize

int $samplesFileSize = 0
protected

См. определение в файле exportaction.php строка 42

◆ $samplesRestriction

array $samplesRestriction = []
protected

См. определение в файле exportaction.php строка 39

◆ $tabId

int $tabId = 0
protected

См. определение в файле exportaction.php строка 23

◆ $translationRepositoryLanguages

array $translationRepositoryLanguages = []
staticprotected

См. определение в файле exportaction.php строка 21

◆ $useTranslationRepository

bool $useTranslationRepository = false
staticprotected

См. определение в файле exportaction.php строка 19

Объявления и описания членов класса находятся в файле: