<?php
+use Civi\Core\Format;
+
/**
* Class Civi
*
return \Civi\Core\Container::getBootService('paths');
}
+ /**
+ * Obtain the formatting object.
+ *
+ * @return \Civi\Core\Format
+ */
+ public static function format(): Format {
+ return new Civi\Core\Format();
+ }
+
+ /**
+ * Initiate a bidirectional pipe for exchanging a series of multiple API requests.
+ *
+ * @param string $negotiationFlags
+ * List of pipe initialization flags. Some combination of the following:
+ * - 'v': Report version in connection header.
+ * - 'j': Report JSON-RPC flavors in connection header.
+ * - 'l': Report on login support in connection header.
+ * - 't': Trusted session. Logins do not require credentials. API calls may execute with or without permission-checks.
+ * - 'u': Untrusted session. Logins require credentials. API calls may only execute with permission-checks.
+ *
+ * The `Civi::pipe()` entry-point is designed to be amenable to shell orchestration (SSH/cv/drush/wp-cli/etc).
+ * The negotiation flags are therefore condensed to individual characters.
+ *
+ * It is possible to preserve compatibility while adding new default-flags. However, removing default-flags
+ * is more likely to be a breaking-change.
+ *
+ * When adding a new flag, consider whether mutable `option()`s may be more appropriate.
+ * @see \Civi\Pipe\PipeSession
+ */
+ public static function pipe(string $negotiationFlags = 'vtl'): void {
+ Civi::service('civi.pipe')
+ ->setIO(STDIN, STDOUT)
+ ->run($negotiationFlags);
+ }
+
/**
* Fetch a service from the container.
*