ProcessLanguage::processCSV() method

Process a CSV file to import changes from it

Must be in the same format as the one provied by the executeDownload() method

Available since version 3.0.195. Previously was not hookable

Usage

// basic usage
$bool = $processLanguage->processCSV(string $csvFile, Language $language);

// usage with all arguments
$bool = $processLanguage->processCSV(string $csvFile, Language $language, array $options = []);

Arguments

Name Type(s) Description

csvFile string

language Language

Name	Type(s)	Description
`csvFile`	string
`language`	Language
`options` (optional)	array	Additional options (3.0.181+) `file` (string): Use this path/file (relative to install root) `quiet` (bool): Suppress generating notifications? (default=false)

options (optional)

array

Additional options (3.0.181+)

file (string): Use this path/file (relative to install root)
quiet (bool): Suppress generating notifications? (default=false)

Return value

bool int

Returns false on error or integer on success, where value is number of translations imported

Exceptions

Method can throw exceptions on error:

WireException

Hooking ProcessLanguage::processCSV(…)

You can add your own hook events that are executed either before or after the ProcessLanguage::processCSV(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each ProcessLanguage::processCSV(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('ProcessLanguage::processCSV', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProcessLanguage = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $csvFile = $event->arguments(0);
  $language = $event->arguments(1);
  $options = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $csvFile);
  $event->arguments(1, $language);
  $event->arguments(2, $options);
});

Hooking after

The 'after' hooks are called immediately after each ProcessLanguage::processCSV(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('ProcessLanguage::processCSV', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProcessLanguage = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $csvFile = $event->arguments(0);
  $language = $event->arguments(1);
  $options = $event->arguments(2);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

ProcessLanguage methods and properties

API reference based on ProcessWire core version 3.0.236