Skip to content

Commit 10cd620

Browse files
mmelogranommelograno
committed
updated phpdoc for client
1 parent 14f154b commit 10cd620

1 file changed

Lines changed: 49 additions & 49 deletions

File tree

‎src/SplitIO/Sdk/ClientInterface.php‎

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -4,64 +4,64 @@
44
interface ClientInterface
55
{
66
/**
7-
* Returns the treatment to show this id for this feature.
8-
* The set of treatments for a feature can be configured
9-
* on the Split web console.
7+
* Returns the treatment to show this id for this feature flag.
8+
* The set of treatments for a feature flag can be configured
9+
* on the Split user interface.
1010
* This method returns the string 'control' if:
1111
* <ol>
1212
* <li>Any of the parameters were null</li>
1313
* <li>There was an exception</li>
14-
* <li>The SDK does not know this feature</li>
15-
* <li>The feature was deleted through the web console.</li>
14+
* <li>The SDK does not know this feature flag</li>
15+
* <li>The feature flag was deleted through the web console.</li>
1616
* </ol>
1717
* 'control' is a reserved treatment, to highlight these
1818
* exceptional circumstances.
1919
*
2020
* <p>
21-
* The sdk returns the default treatment of this feature if:
21+
* The sdk returns the default treatment of this feature flag if:
2222
* <ol>
23-
* <li>The feature was killed</li>
23+
* <li>The feature flag was killed</li>
2424
* <li>The id did not match any of the conditions in the
25-
* feature roll-out plan</li>
25+
* feature flag roll-out plan</li>
2626
* </ol>
27-
* The default treatment of a feature is set on the Split web
28-
* console.
27+
* The default treatment of a feature flag is set on the Split user
28+
* interface.
2929
*
3030
* <p>
3131
* This method does not throw any exceptions.
3232
* It also never returns null.
3333
*
3434
* @param $key
35-
* @param $featureName
35+
* @param $featureFlagName
3636
* @param $attributes
3737
* @return string
3838
*/
39-
public function getTreatment($key, $featureName, array $attributes = null);
39+
public function getTreatment($key, $featureFlagName, array $attributes = null);
4040

4141
/**
4242
* Returns an object with the treatment to show this id for this feature
43-
* and the config provided.
44-
* The set of treatments and config for a feature can be configured
45-
* on the Split web console.
43+
* flag and the config provided.
44+
* The set of treatments and config for a feature flag can be configured
45+
* on the Split user interface.
4646
* This method returns the string 'control' if:
4747
* <ol>
4848
* <li>Any of the parameters were null</li>
4949
* <li>There was an exception</li>
50-
* <li>The SDK does not know this feature</li>
51-
* <li>The feature was deleted through the web console.</li>
50+
* <li>The SDK does not know this feature flag</li>
51+
* <li>The feature flag was deleted through the web console.</li>
5252
* </ol>
5353
* 'control' is a reserved treatment, to highlight these
5454
* exceptional circumstances.
5555
*
5656
* <p>
57-
* The sdk returns the default treatment of this feature if:
57+
* The sdk returns the default treatment of this feature flag if:
5858
* <ol>
59-
* <li>The feature was killed</li>
59+
* <li>The feature flag was killed</li>
6060
* <li>The id did not match any of the conditions in the
61-
* feature roll-out plan</li>
61+
* feature flag roll-out plan</li>
6262
* </ol>
63-
* The default treatment of a feature is set on the Split web
64-
* console.
63+
* The default treatment of a feature flag is set on the Split user
64+
* interface.
6565
*
6666
* <p>
6767
* This method does not throw any exceptions.
@@ -72,95 +72,95 @@ public function getTreatment($key, $featureName, array $attributes = null);
7272
* <li>config was not set up</li>
7373
* </ol>
7474
* @param $key
75-
* @param $featureName
75+
* @param $featureFlagName
7676
* @param $attributes
7777
* @return array
7878
*/
79-
public function getTreatmentWithConfig($key, $featureName, array $attributes = null);
79+
public function getTreatmentWithConfig($key, $featureFlagName, array $attributes = null);
8080

8181
/**
8282
* Returns an associative array which each key will be
83-
* the treatment result for each feature passed as parameter.
84-
* The set of treatments for a feature can be configured
85-
* on the Split web console.
83+
* the treatment result for each feature flag passed as parameter.
84+
* The set of treatments for a feature flag can be configured
85+
* on the Split user interface.
8686
* This method returns the string 'control' if:
8787
* <ol>
88-
* <li>featureNames is invalid/li>
88+
* <li>featureFlagNames is invalid/li>
8989
* </ol>
9090
* 'control' is a reserved treatment, to highlight these
9191
* exceptional circumstances.
9292
*
9393
* <p>
94-
* The sdk returns the default treatment of this feature if:
94+
* The sdk returns the default treatment of this feature flag if:
9595
* <ol>
96-
* <li>The feature was killed</li>
96+
* <li>The feature flag was killed</li>
9797
* <li>The id did not match any of the conditions in the
98-
* feature roll-out plan</li>
98+
* feature flag roll-out plan</li>
9999
* </ol>
100-
* The default treatment of a feature is set on the Split web
101-
* console.
100+
* The default treatment of a feature flag is set on the Split user
101+
* interface.
102102
*
103103
* <p>
104104
* This method does not throw any exceptions.
105105
* It also never returns null.
106106
*
107107
* @param $key
108-
* @param $featureNames
108+
* @param $featureFlagNames
109109
* @param $attributes
110110
* @return array
111111
*/
112-
public function getTreatments($key, $featureNames, array $attributes = null);
112+
public function getTreatments($key, $featureFlagNames, array $attributes = null);
113113

114114
/**
115115
* Returns an associative array which each key will be
116116
* the treatment result and the config for each
117-
* feature passed as parameter.
118-
* The set of treatments for a feature can be configured
119-
* on the Split web console and the config for
117+
* feature flag passed as parameter.
118+
* The set of treatments for a feature flag can be configured
119+
* on the Split user interface and the config for
120120
* that treatment.
121121
* This method returns the string 'control' if:
122122
* <ol>
123-
* <li>featureNames is invalid/li>
123+
* <li>featureFlagNames is invalid/li>
124124
* </ol>
125125
* 'control' is a reserved treatment, to highlight these
126126
* exceptional circumstances.
127127
*
128128
* <p>
129-
* The sdk returns the default treatment of this feature if:
129+
* The sdk returns the default treatment of this feature flag if:
130130
* <ol>
131-
* <li>The feature was killed</li>
131+
* <li>The feature flag was killed</li>
132132
* <li>The id did not match any of the conditions in the
133-
* feature roll-out plan</li>
133+
* feature flag roll-out plan</li>
134134
* </ol>
135-
* The default treatment of a feature is set on the Split web
136-
* console.
135+
* The default treatment of a feature flag is set on the Split user
136+
* interface.
137137
*
138138
* <p>
139139
* This method does not throw any exceptions.
140140
* It also never returns null.
141141
*
142142
* @param $key
143-
* @param $featureNames
143+
* @param $featureFlagNames
144144
* @param $attributes
145145
* @return array
146146
*/
147-
public function getTreatmentsWithConfig($key, $featureNames, array $attributes = null);
147+
public function getTreatmentsWithConfig($key, $featureFlagNames, array $attributes = null);
148148

149149
/**
150150
* A short-hand for
151151
* <pre>
152-
* (getTreatment(key, feature) == treatment) ? true : false;
152+
* (getTreatment(key, featureFlagName) == treatment) ? true : false;
153153
* </pre>
154154
*
155155
* This method never throws exceptions.
156156
* Instead of throwing exceptions, it returns false.
157157
*
158158
* @param $key
159-
* @param $featureName
159+
* @param $featureFlagName
160160
* @param $treatment
161161
* @return bool
162162
*/
163-
public function isTreatment($key, $featureName, $treatment);
163+
public function isTreatment($key, $featureFlagName, $treatment);
164164

165165
/**
166166
* Method to send events

0 commit comments

Comments
 (0)