FormBuilderEntries::getFilesPath() method

Return the path that may be used by entries

Usage

// basic usage
$string = $formBuilderEntries->getFilesPath();

// usage with all arguments
$string = $formBuilderEntries->getFilesPath(int $entryID = 0, bool $create = true, int $formID = 0);

Arguments

Name	Type(s)	Description
`entryID` (optional)	int	When specified, will return the path for a specific entry's files
`create` (optional)	bool	Create path if it does not exist?
`formID` (optional)	int	Optional form ID, if different from the one for this FormBuilderEntries class

Return value

string

Hooking FormBuilderEntries::getFilesPath(…)

You can add your own hook events that are executed either before or after the FormBuilderEntries::getFilesPath(…) 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 FormBuilderEntries::getFilesPath(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

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

  // Get values of arguments sent to hook (and optionally modify them)
  $entryID = $event->arguments(0);
  $create = $event->arguments(1);
  $formID = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $entryID);
  $event->arguments(1, $create);
  $event->arguments(2, $formID);
});

Hooking after

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

$this->addHookAfter('FormBuilderEntries::getFilesPath', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FormBuilderEntries = $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)
  $entryID = $event->arguments(0);
  $create = $event->arguments(1);
  $formID = $event->arguments(2);

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

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

FormBuilderEntries methods and properties

API reference based on ProcessWire core version 3.0.244