class FillPdf in FillPDF 5.0.x

Class FillPdf.

@package Drupal\fillpdf\Component\Utility

Hierarchy

• class \Drupal\fillpdf\Component\Utility\FillPdf

8 files declare their use of FillPdf

FillPdfFormForm.php in src/Form/FillPdfFormForm.php

FillPdfOverviewForm.php in src/Form/FillPdfOverviewForm.php

FillPdfSettingsForm.php in src/Form/FillPdfSettingsForm.php

FillPdfUploadTestBase.php in tests/src/Functional/FillPdfUploadTestBase.php

OutputHandler.php in src/OutputHandler.php

... See full list

File

src/Component/Utility/FillPdf.php, line 17

Namespace

Drupal\fillpdf\Component\Utility

class FillPdf {

  /**
   * Tests the connection to a local pdftk installation.
   *
   * @param string $pdftk_path
   *   (optional) A pdftk path differing from 'pdftk'. Defaults to ''.
   *
   * @return bool
   *   TRUE if pdftk could be reached, otherwise FALSE.
   */
  public static function checkPdftkPath($pdftk_path = '') {

    // An empty value means we should leave it to the PATH.
    if (empty($pdftk_path)) {
      $pdftk_path = 'pdftk';
    }
    $process = new Process($pdftk_path . ' --version');
    $process
      ->run();

    // Check there's no error code and the --version output includes "pdftk".
    return !in_array($process
      ->getExitCode(), [
      126,
      127,
    ], TRUE) && strpos($process
      ->getOutput(), 'pdftk') !== FALSE;
  }

  /**
   * Correctly embed a View with arguments.
   *
   * Views_embed_view() does not zero-index.
   *
   * @param string $name
   *   Name of the view to embed.
   * @param string $display_id
   *   (optional) The display ID. Defaults to 'default'.
   *
   * @return array|null
   *   A renderable array containing the view output or NULL if the display ID
   *   of the view to be executed doesn't exist.
   *
   * @see views_embed_view()
   */
  public static function embedView($name, $display_id = 'default') {
    $args = func_get_args();

    // Remove $name and $display_id from the arguments.
    unset($args[0], $args[1]);
    $args = array_values($args);
    $view = Views::getView($name);
    if (!$view || !$view
      ->access($display_id)) {
      return NULL;
    }
    return $view
      ->preview($display_id, $args);
  }

  /**
   * Constructs a URI to a location given a relative path.
   *
   * @param string $scheme
   *   A valid stream wrapper, such as 'public' or 'private'.
   * @param string $path
   *   The path component that should come after the stream wrapper.
   *
   * @return string
   *   The normalized URI.
   */
  public static function buildFileUri($scheme, $path) {
    $uri = $scheme . '://' . $path;

    /** @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $streamWrapperManager */
    $streamWrapperManager = \Drupal::service('stream_wrapper_manager');
    return $streamWrapperManager
      ->normalizeUri($uri);
  }

  /**
   * Tests the connection to a local service endpoint.
   *
   * @param \GuzzleHttp\Client $http_client
   *   The Guzzle http client.
   * @param \Drupal\Core\Config\Config $fillpdf_config
   *   FillPDF configuration object.
   *
   * @return bool
   *   TRUE if a connection could be established, otherwise FALSE.
   */
  public static function checkLocalServiceEndpoint(Client $http_client, Config $fillpdf_config) {
    try {
      $response = $http_client
        ->get($fillpdf_config
        ->get('local_service_endpoint'));
    } catch (Exception $exception) {

      // If any thing goes wrong, just fail the check.
      return FALSE;
    }

    // Only consider the check passed if we actually get a 200 from the API.
    return $response
      ->getStatusCode() === 200;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FillPdf::buildFileUri	public static	function	Constructs a URI to a location given a relative path.
FillPdf::checkLocalServiceEndpoint	public static	function	Tests the connection to a local service endpoint.
FillPdf::checkPdftkPath	public static	function	Tests the connection to a local pdftk installation.
FillPdf::embedView	public static	function	Correctly embed a View with arguments.