comparison vendor/consolidation/site-process/src/Factory/TransportFactoryInterface.php @ 5:12f9dff5fda9 tip

Update to Drupal core 8.7.1
author Chris Cannam
date Thu, 09 May 2019 15:34:47 +0100
parents
children
comparison
equal deleted inserted replaced
4:a9cd425dd02b 5:12f9dff5fda9
1 <?php
2
3 namespace Consolidation\SiteProcess\Factory;
4
5 use Consolidation\SiteAlias\SiteAliasInterface;
6 use Consolidation\SiteProcess\Transport\TransportInterface;
7 use Consolidation\Config\ConfigInterface;
8
9 /**
10 * TransportFactoryInterface defines a transport factory that is responsible
11 * for:
12 *
13 * - Determining whether a provided site alias is applicable to this transport
14 * - Creating an instance of a transport for an applicable site alias.
15 *
16 * There is always a transport for every factory, and visa-versa.
17 * @see Consolidation\SiteProcess\Transport\TransportInterface
18 */
19 interface TransportFactoryInterface
20 {
21 /**
22 * Check to see if a provided site alias is applicable to this transport type.
23 * @param SiteAliasInterface $siteAlias
24 * @return bool
25 */
26 public function check(SiteAliasInterface $siteAlias);
27
28 /**
29 * Create a transport instance for an applicable site alias.
30 * @param SiteAliasInterface $siteAlias
31 * @return TransportInterface
32 */
33 public function create(SiteAliasInterface $siteAlias);
34 }