|
| 1 | +<!DOCTYPE html> |
| 2 | +<html lang="en"> |
| 3 | +<head> |
| 4 | + <meta charset="utf-8"> |
| 5 | + <title>LaunchDarkly PHP SDK 6.5.0</title> |
| 6 | + |
| 7 | + <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| 8 | + <base href="../"> |
| 9 | + <link rel="icon" href="images/favicon.ico"/> |
| 10 | + <link rel="stylesheet" href="css/normalize.css"> |
| 11 | + <link rel="stylesheet" href="css/base.css"> |
| 12 | + <link rel="preconnect" href="https://fonts.gstatic.com"> |
| 13 | + <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet"> |
| 14 | + <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet"> |
| 15 | + <link rel="stylesheet" href="css/template.css"> |
| 16 | + <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" /> |
| 17 | + <link rel=" stylesheet" href=" https://cdn.jsdelivr.net/npm/[email protected]/themes/prism-okaidia.css" > |
| 18 | + <link rel=" stylesheet" href=" https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-numbers/prism-line-numbers.css" > |
| 19 | + <link rel=" stylesheet" href=" https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-highlight/prism-line-highlight.css" > |
| 20 | + <script src=" https://cdn.jsdelivr.net/npm/[email protected]" ></script> |
| 21 | + <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script> |
| 22 | + <script src="js/search.js"></script> |
| 23 | + <script defer src="js/searchIndex.js"></script> |
| 24 | + </head> |
| 25 | +<body id="top"> |
| 26 | + <header class="phpdocumentor-header phpdocumentor-section"> |
| 27 | + <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">LaunchDarkly PHP SDK 6.5.0</a></h1> |
| 28 | + <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" /> |
| 29 | + <label class="phpdocumentor-header__menu-icon" for="menu-button"> |
| 30 | + <i class="fas fa-bars"></i> |
| 31 | + </label> |
| 32 | + <section data-search-form class="phpdocumentor-search"> |
| 33 | + <label> |
| 34 | + <span class="visually-hidden">Search for</span> |
| 35 | + <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg"> |
| 36 | + <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/> |
| 37 | + <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/> |
| 38 | + </svg> |
| 39 | + <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled /> |
| 40 | + </label> |
| 41 | +</section> |
| 42 | + |
| 43 | + <nav class="phpdocumentor-topnav"> |
| 44 | + <ul class="phpdocumentor-topnav__menu"> |
| 45 | + </ul> |
| 46 | +</nav> |
| 47 | +</header> |
| 48 | + |
| 49 | + <main class="phpdocumentor"> |
| 50 | + <div class="phpdocumentor-section"> |
| 51 | + <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" /> |
| 52 | +<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button"> |
| 53 | + Menu |
| 54 | +</label> |
| 55 | +<aside class="phpdocumentor-column -four phpdocumentor-sidebar"> |
| 56 | + <section class="phpdocumentor-sidebar__category"> |
| 57 | + <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2> |
| 58 | + <h4 class="phpdocumentor-sidebar__root-namespace"> |
| 59 | + <a href="namespaces/launchdarkly.html" class="">LaunchDarkly</a> |
| 60 | +</h4> |
| 61 | + <ul class="phpdocumentor-list"> |
| 62 | + <li> |
| 63 | + <a href="namespaces/launchdarkly-integrations.html" class="">Integrations</a> |
| 64 | + |
| 65 | + </li> |
| 66 | + <li> |
| 67 | + <a href="namespaces/launchdarkly-migrations.html" class="">Migrations</a> |
| 68 | + |
| 69 | + </li> |
| 70 | + <li> |
| 71 | + <a href="namespaces/launchdarkly-subsystems.html" class="">Subsystems</a> |
| 72 | + |
| 73 | + </li> |
| 74 | + <li> |
| 75 | + <a href="namespaces/launchdarkly-types.html" class="">Types</a> |
| 76 | + |
| 77 | + </li> |
| 78 | + </ul> |
| 79 | + |
| 80 | + </section> |
| 81 | + <section class="phpdocumentor-sidebar__category"> |
| 82 | + <h2 class="phpdocumentor-sidebar__category-header">Packages</h2> |
| 83 | + <h4 class="phpdocumentor-sidebar__root-namespace"> |
| 84 | + <a href="packages/LaunchDarkly.html" class="">LaunchDarkly</a> |
| 85 | +</h4> |
| 86 | + |
| 87 | + </section> |
| 88 | + |
| 89 | + <section class="phpdocumentor-sidebar__category"> |
| 90 | + <h2 class="phpdocumentor-sidebar__category-header">Reports</h2> |
| 91 | + <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3> |
| 92 | + <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3> |
| 93 | + <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3> |
| 94 | + </section> |
| 95 | + |
| 96 | + <section class="phpdocumentor-sidebar__category"> |
| 97 | + <h2 class="phpdocumentor-sidebar__category-header">Indices</h2> |
| 98 | + <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3> |
| 99 | + </section> |
| 100 | +</aside> |
| 101 | + |
| 102 | + <div class="phpdocumentor-column -eight phpdocumentor-content"> |
| 103 | + <ul class="phpdocumentor-breadcrumbs"> |
| 104 | + <li class="phpdocumentor-breadcrumb"><a href="namespaces/launchdarkly.html">LaunchDarkly</a></li> |
| 105 | + </ul> |
| 106 | + |
| 107 | + <article class="phpdocumentor-element -class"> |
| 108 | + <h2 class="phpdocumentor-content__title"> |
| 109 | + BigSegmentsEvaluationStatus |
| 110 | + |
| 111 | + <span class="phpdocumentor-element__extends"> |
| 112 | + : string |
| 113 | + </span> |
| 114 | + |
| 115 | + <div class="phpdocumentor-element__package"> |
| 116 | + in package |
| 117 | + <ul class="phpdocumentor-breadcrumbs"> |
| 118 | + </ul> |
| 119 | + </div> |
| 120 | + |
| 121 | + |
| 122 | + </h2> |
| 123 | + |
| 124 | + <aside class="phpdocumentor-element-found-in"> |
| 125 | + <abbr class="phpdocumentor-element-found-in__file" title="src/LaunchDarkly/BigSegmentsEvaluationStatus.php"><a href="files/src-launchdarkly-bigsegmentsevaluationstatus.html"><abbr title="src/LaunchDarkly/BigSegmentsEvaluationStatus.php">BigSegmentsEvaluationStatus.php</abbr></a></abbr> |
| 126 | + : |
| 127 | + <span class="phpdocumentor-element-found-in__line">11</span> |
| 128 | + |
| 129 | + </aside> |
| 130 | + |
| 131 | + <p class="phpdocumentor-summary">A status enum which represents the result of a Big Segment query involved in |
| 132 | +a flag evaluation.</p> |
| 133 | + |
| 134 | + |
| 135 | + |
| 136 | + |
| 137 | + |
| 138 | + |
| 139 | + |
| 140 | + |
| 141 | + |
| 142 | + |
| 143 | + |
| 144 | + |
| 145 | + <section class="phpdocumentor-cases"> |
| 146 | + <h3 class="phpdocumentor-elements__header" id="cases"> |
| 147 | + Cases |
| 148 | + <a href="classes/LaunchDarkly-BigSegmentsEvaluationStatus.html#cases" class="headerlink"><i class="fas fa-link"></i></a> |
| 149 | + </h3> |
| 150 | + <article |
| 151 | + class=" |
| 152 | + phpdocumentor-element |
| 153 | + -enum-case |
| 154 | + " |
| 155 | +> |
| 156 | + <h4 class="phpdocumentor-element__name" id="enumcase_HEALTHY"> |
| 157 | + HEALTHY |
| 158 | + <a href="" class="headerlink"><i class="fas fa-link"></i></a> |
| 159 | + </h4> |
| 160 | + <aside class="phpdocumentor-element-found-in"> |
| 161 | + <abbr class="phpdocumentor-element-found-in__file" title="src/LaunchDarkly/BigSegmentsEvaluationStatus.php"><a href="files/src-launchdarkly-bigsegmentsevaluationstatus.html"><abbr title="src/LaunchDarkly/BigSegmentsEvaluationStatus.php">BigSegmentsEvaluationStatus.php</abbr></a></abbr> |
| 162 | + : |
| 163 | + <span class="phpdocumentor-element-found-in__line">17</span> |
| 164 | + |
| 165 | + </aside> |
| 166 | + |
| 167 | + <p class="phpdocumentor-summary">Indicates that the Big Segment query involved in the flag evaluation was |
| 168 | +successful, and that the segment state is considered up to date.</p> |
| 169 | + |
| 170 | + |
| 171 | + <section class="phpdocumentor-description"></section> |
| 172 | + |
| 173 | + |
| 174 | + |
| 175 | +</article> |
| 176 | + <article |
| 177 | + class=" |
| 178 | + phpdocumentor-element |
| 179 | + -enum-case |
| 180 | + " |
| 181 | +> |
| 182 | + <h4 class="phpdocumentor-element__name" id="enumcase_STALE"> |
| 183 | + STALE |
| 184 | + <a href="" class="headerlink"><i class="fas fa-link"></i></a> |
| 185 | + </h4> |
| 186 | + <aside class="phpdocumentor-element-found-in"> |
| 187 | + <abbr class="phpdocumentor-element-found-in__file" title="src/LaunchDarkly/BigSegmentsEvaluationStatus.php"><a href="files/src-launchdarkly-bigsegmentsevaluationstatus.html"><abbr title="src/LaunchDarkly/BigSegmentsEvaluationStatus.php">BigSegmentsEvaluationStatus.php</abbr></a></abbr> |
| 188 | + : |
| 189 | + <span class="phpdocumentor-element-found-in__line">23</span> |
| 190 | + |
| 191 | + </aside> |
| 192 | + |
| 193 | + <p class="phpdocumentor-summary">Indicates that the Big Segment query involved in the flag evaluation was |
| 194 | +successful, but that the segment state may not be up to date.</p> |
| 195 | + |
| 196 | + |
| 197 | + <section class="phpdocumentor-description"></section> |
| 198 | + |
| 199 | + |
| 200 | + |
| 201 | +</article> |
| 202 | + <article |
| 203 | + class=" |
| 204 | + phpdocumentor-element |
| 205 | + -enum-case |
| 206 | + " |
| 207 | +> |
| 208 | + <h4 class="phpdocumentor-element__name" id="enumcase_NOT_CONFIGURED"> |
| 209 | + NOT_CONFIGURED |
| 210 | + <a href="" class="headerlink"><i class="fas fa-link"></i></a> |
| 211 | + </h4> |
| 212 | + <aside class="phpdocumentor-element-found-in"> |
| 213 | + <abbr class="phpdocumentor-element-found-in__file" title="src/LaunchDarkly/BigSegmentsEvaluationStatus.php"><a href="files/src-launchdarkly-bigsegmentsevaluationstatus.html"><abbr title="src/LaunchDarkly/BigSegmentsEvaluationStatus.php">BigSegmentsEvaluationStatus.php</abbr></a></abbr> |
| 214 | + : |
| 215 | + <span class="phpdocumentor-element-found-in__line">29</span> |
| 216 | + |
| 217 | + </aside> |
| 218 | + |
| 219 | + <p class="phpdocumentor-summary">Indicates that Big Segments could not be queried for the flag evaluation |
| 220 | +because the SDK configuration did not include a Big Segment store.</p> |
| 221 | + |
| 222 | + |
| 223 | + <section class="phpdocumentor-description"></section> |
| 224 | + |
| 225 | + |
| 226 | + |
| 227 | +</article> |
| 228 | + <article |
| 229 | + class=" |
| 230 | + phpdocumentor-element |
| 231 | + -enum-case |
| 232 | + " |
| 233 | +> |
| 234 | + <h4 class="phpdocumentor-element__name" id="enumcase_STORE_ERROR"> |
| 235 | + STORE_ERROR |
| 236 | + <a href="" class="headerlink"><i class="fas fa-link"></i></a> |
| 237 | + </h4> |
| 238 | + <aside class="phpdocumentor-element-found-in"> |
| 239 | + <abbr class="phpdocumentor-element-found-in__file" title="src/LaunchDarkly/BigSegmentsEvaluationStatus.php"><a href="files/src-launchdarkly-bigsegmentsevaluationstatus.html"><abbr title="src/LaunchDarkly/BigSegmentsEvaluationStatus.php">BigSegmentsEvaluationStatus.php</abbr></a></abbr> |
| 240 | + : |
| 241 | + <span class="phpdocumentor-element-found-in__line">35</span> |
| 242 | + |
| 243 | + </aside> |
| 244 | + |
| 245 | + <p class="phpdocumentor-summary">Indicates that the Big Segment query involved in the flag evaluation |
| 246 | +failed, for instance due to a database error.</p> |
| 247 | + |
| 248 | + |
| 249 | + <section class="phpdocumentor-description"></section> |
| 250 | + |
| 251 | + |
| 252 | + |
| 253 | +</article> |
| 254 | + </section> |
| 255 | + |
| 256 | + |
| 257 | + |
| 258 | + <script type="text/javascript"> |
| 259 | + function loadExternalCodeSnippets(line) { |
| 260 | + Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => { |
| 261 | + var src = pre.getAttribute('data-src').replace( /\\/g, '/'); |
| 262 | + var extension = (src.match(/\.(\w+)$/) || [, ''])[1]; |
| 263 | + var language = 'php'; |
| 264 | + |
| 265 | + var code = document.createElement('code'); |
| 266 | + code.className = 'language-' + language; |
| 267 | + |
| 268 | + pre.textContent = ''; |
| 269 | + |
| 270 | + pre.setAttribute('data-line', line) |
| 271 | + code.textContent = 'Loading…'; |
| 272 | + |
| 273 | + pre.appendChild(code); |
| 274 | + |
| 275 | + var xhr = new XMLHttpRequest(); |
| 276 | + |
| 277 | + xhr.open('GET', src, true); |
| 278 | + |
| 279 | + xhr.onreadystatechange = function () { |
| 280 | + if (xhr.readyState == 4) { |
| 281 | + |
| 282 | + if (xhr.status < 400 && xhr.responseText) { |
| 283 | + code.textContent = xhr.responseText; |
| 284 | + |
| 285 | + Prism.highlightElement(code); |
| 286 | + } |
| 287 | + else if (xhr.status >= 400) { |
| 288 | + code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText; |
| 289 | + } |
| 290 | + else { |
| 291 | + code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost'; |
| 292 | + } |
| 293 | + } |
| 294 | + }; |
| 295 | + |
| 296 | + xhr.send(null); |
| 297 | + }); |
| 298 | + } |
| 299 | + |
| 300 | + var modals = document.querySelectorAll("[data-modal]"); |
| 301 | + |
| 302 | + modals.forEach(function (trigger) { |
| 303 | + trigger.addEventListener("click", function (event) { |
| 304 | + //event.preventDefault(); |
| 305 | + const modal = document.getElementById(trigger.dataset.modal); |
| 306 | + modal.classList.add("phpdocumentor-modal__open"); |
| 307 | + loadExternalCodeSnippets(trigger.dataset.line) |
| 308 | + const exits = modal.querySelectorAll("[data-exit-button]"); |
| 309 | + exits.forEach(function (exit) { |
| 310 | + exit.addEventListener("click", function (event) { |
| 311 | + event.preventDefault(); |
| 312 | + modal.classList.remove("phpdocumentor-modal__open"); |
| 313 | + }); |
| 314 | + }); |
| 315 | + }); |
| 316 | + }); |
| 317 | + </script> |
| 318 | + |
| 319 | + </article> |
| 320 | + <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden"> |
| 321 | + <section class="phpdocumentor-search-results__dialog"> |
| 322 | + <header class="phpdocumentor-search-results__header"> |
| 323 | + <h2 class="phpdocumentor-search-results__title">Search results</h2> |
| 324 | + <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button> |
| 325 | + </header> |
| 326 | + <section class="phpdocumentor-search-results__body"> |
| 327 | + <ul class="phpdocumentor-search-results__entries"></ul> |
| 328 | + </section> |
| 329 | + </section> |
| 330 | +</section> |
| 331 | + </div> |
| 332 | + </div> |
| 333 | + <a href="classes/LaunchDarkly-BigSegmentsEvaluationStatus.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a> |
| 334 | + |
| 335 | + </main> |
| 336 | + |
| 337 | + <script> |
| 338 | + cssVars({}); |
| 339 | + </script> |
| 340 | + <script src=" https://cdn.jsdelivr.net/npm/[email protected]/prism.min.js" ></script> |
| 341 | + <script src=" https://cdn.jsdelivr.net/npm/[email protected]/plugins/autoloader/prism-autoloader.min.js" ></script> |
| 342 | + <script src=" https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-numbers/prism-line-numbers.min.js" ></script> |
| 343 | + <script src=" https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-highlight/prism-line-highlight.min.js" ></script> |
| 344 | +</body> |
| 345 | +</html> |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments