aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_external/3rdparty/icewind/smb/src/ISystem.php
blob: 90209f9ae248eccdc5aa6766f45df296debc86fe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<?php
/**
 * SPDX-FileCopyrightText: 2018 Robin Appelman <robin@icewind.nl>
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace Icewind\SMB;

/**
 * The `ISystem` interface provides a way to access system dependent information
 * such as the availability and location of certain binaries.
 */
interface ISystem {
	/**
	 * Get the path to a file descriptor of the current process
	 *
	 * @param int $num the file descriptor id
	 * @return string
	 */
	public function getFD(int $num): string;

	/**
	 * Get the full path to the `smbclient` binary of null if the binary is not available
	 *
	 * @return string|null
	 */
	public function getSmbclientPath(): ?string;

	/**
	 * Get the full path to the `net` binary of null if the binary is not available
	 *
	 * @return string|null
	 */
	public function getNetPath(): ?string;

	/**
	 * Get the full path to the `smbcacls` binary of null if the binary is not available
	 *
	 * @return string|null
	 */
	public function getSmbcAclsPath(): ?string;

	/**
	 * Get the full path to the `stdbuf` binary of null if the binary is not available
	 *
	 * @return string|null
	 */
	public function getStdBufPath(): ?string;

	/**
	 * Get the full path to the `date` binary of null if the binary is not available
	 *
	 * @return string|null
	 */
	public function getDatePath(): ?string;

	/**
	 * Whether or not the smbclient php extension is enabled
	 *
	 * @return bool
	 */
	public function libSmbclientAvailable(): bool;
}