super-powers/src/594df747-5bfb-44de-9e47-d3fa83a80134/code.power at master · joomengine/super-powers · GitHub

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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
	/* ==========================================================================
	 * Import Queue
	 * ========================================================================== */

	/**
	 * Get the import queue table name.
	 *
	 * @return string
	 * @since  5.1.4
	 */
	public function getQueueTable(): string;

	/**
	 * Set the import queue table name.
	 *
	 * @param  string  $table  The import queue table.
	 *
	 * @return self
	 * @since  5.1.4
	 *
	 * @throws  \InvalidArgumentException
	 */
	public function setQueueTable(string $table): self;

	/**
	 * Get the status field name used for import state tracking.
	 *
	 * @return string
	 * @since  5.1.4
	 */
	public function getQueueStatusField(): string;

	/**
	 * Set the status field.
	 *
	 * @param  string  $field
	 *
	 * @return self
	 * @since  5.1.4
	 *
	 * @throws  \InvalidArgumentException
	 */
	public function setQueueStatusField(string $field): self;

	/**
	 * Get the status value representing a wait state.
	 *
	 * @return int
	 * @since  5.1.4
	 */
	public function getQueueWaitState(): int;

	/**
	 * Set the status value representing a wait state.
	 *
	 * @param  int  $status  Processing status value.
	 *
	 * @return self
	 * @since  5.1.4
	 */
	public function setQueueWaitState(int $status): self;

	/**
	 * Get the status value representing a processing import.
	 *
	 * @return int
	 * @since  5.1.4
	 */
	public function getQueueProcessingState(): int;

	/**
	 * Set the status value representing a processing import.
	 *
	 * @param  int  $status  Processing status value.
	 *
	 * @return self
	 * @since  5.1.4
	 *
	 * @throws  \InvalidArgumentException
	 */
	public function setQueueProcessingState(int $status): self;

	/**
	 * Get the status value representing an success state.
	 *
	 * @return int
	 * @since  5.1.4
	 */
	public function getQueueSuccessState(): int;

	/**
	 * Set the success status value.
	 *
	 * @param  int  $status
	 *
	 * @return self
	 * @since  5.1.4
	 *
	 * @throws  \InvalidArgumentException
	 */
	public function setQueueSuccessState(int $status): self;

	/**
	 * Get the status value representing an error state.
	 *
	 * @return int
	 * @since  5.1.4
	 */
	public function getQueueErrorState(): int;

	/**
	 * Set the status value representing an error state.
	 *
	 * @param  int  $status  Error status value.
	 *
	 * @return self
	 * @since  5.1.4
	 */
	public function setQueueErrorState(int $status): self;

	/* ==========================================================================
	 * Logging & Files
	 * ========================================================================== */

	/**
	 * Get the message log table name.
	 *
	 * @return string
	 * @since  5.1.4
	 */
	public function getMessageLogTable(): string;

	/**
	 * Set the message log table name.
	 *
	 * @param  string  $table  The message log table.
	 *
	 * @return self
	 * @since  5.1.4
	 *
	 * @throws  \InvalidArgumentException
	 */
	public function setMessageLogTable(string $table): self;

	/**
	 * Get the file table name.
	 *
	 * @return string
	 * @since  5.1.4
	 */
	public function getFileTable(): string;

	/**
	 * Set the file table name.
	 *
	 * @param  string  $table  The file table.
	 *
	 * @return self
	 * @since  5.1.4
	 *
	 * @throws  \InvalidArgumentException
	 */
	public function setFileTable(string $table): self;