Skip to content

Commit b1cb71d

Browse files
committed
Api documentations update (Mon Jan 13 12:19:44 UTC 2025)
#apidocs
1 parent 9ae7684 commit b1cb71d

File tree

13 files changed

+952
-8
lines changed

13 files changed

+952
-8
lines changed
Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="robots" content="index, follow, all" />
6+
<title>JsonPath | PHP Jetbrains phpstorm-stubs</title>
7+
8+
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
9+
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
10+
<link rel="stylesheet" type="text/css" href="css/doctum.css">
11+
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
12+
<script src="js/jquery-3.5.1.slim.min.js"></script>
13+
<script async defer src="doctum.js"></script>
14+
<script async defer src="js/bootstrap.min.js"></script>
15+
<script async defer src="js/autocomplete.min.js"></script>
16+
<meta name="MobileOptimized" content="width">
17+
<meta name="HandheldFriendly" content="true">
18+
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
19+
20+
</head>
21+
22+
<body id="namespace" data-name="namespace:JsonPath" data-root-path="" data-search-index-url="doctum-search.json">
23+
<div id="content">
24+
<div id="left-column">
25+
<div id="control-panel">
26+
<div class="search-bar hidden" id="search-progress-bar-container">
27+
<div class="progress">
28+
<div class="progress-bar" role="progressbar" id="search-progress-bar"
29+
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
30+
</div>
31+
</div>
32+
<form id="search-form" action="search.html">
33+
<span class="icon icon-search"></span>
34+
<input name="search"
35+
id="doctum-search-auto-complete"
36+
class="typeahead form-control"
37+
type="search"
38+
placeholder="Search"
39+
spellcheck="false"
40+
autocorrect="off"
41+
autocomplete="off"
42+
autocapitalize="off">
43+
<div class="auto-complete-results" id="auto-complete-results"></div>
44+
</form>
45+
</div>
46+
47+
<div id="api-tree"></div>
48+
49+
</div>
50+
<div id="right-column">
51+
<nav id="site-nav" class="navbar navbar-default" role="navigation">
52+
<div class="container-fluid">
53+
<div class="navbar-header">
54+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
55+
<span class="sr-only">Toggle navigation</span>
56+
<span class="icon-bar"></span>
57+
<span class="icon-bar"></span>
58+
<span class="icon-bar"></span>
59+
</button>
60+
<a class="navbar-brand" href="index.html">PHP Jetbrains phpstorm-stubs</a>
61+
</div>
62+
<div class="collapse navbar-collapse" id="navbar-elements">
63+
<ul class="nav navbar-nav">
64+
<li><a href="classes.html">Classes</a></li>
65+
<li><a href="namespaces.html">Namespaces</a></li>
66+
<li><a href="interfaces.html">Interfaces</a></li>
67+
<li><a href="traits.html">Traits</a></li>
68+
<li><a href="doc-index.html">Index</a></li>
69+
<li><a href="search.html">Search</a></li>
70+
</ul>
71+
</div>
72+
</div>
73+
</nav>
74+
75+
<div class="namespace-breadcrumbs">
76+
<ol class="breadcrumb">
77+
<li><span class="label label-default">Namespace</span></li>
78+
<li><a href="JsonPath.html">JsonPath</a></li><li class="backslash">\</li>
79+
</ol>
80+
</div>
81+
<div id="page-content">
82+
<div class="page-header">
83+
<h1>JsonPath</h1>
84+
</div>
85+
86+
87+
<h2>Classes</h2>
88+
<div class="container-fluid underlined">
89+
<div class="row">
90+
<div class="col-md-6">
91+
<a href="JsonPath/JsonPath.html"><abbr title="JsonPath\JsonPath">JsonPath</abbr></a> </div>
92+
<div class="col-md-6"></div>
93+
</div>
94+
<div class="row">
95+
<div class="col-md-6">
96+
<a href="JsonPath/JsonPathException.html"><abbr title="JsonPath\JsonPathException">JsonPathException</abbr></a> </div>
97+
<div class="col-md-6"></div>
98+
</div>
99+
</div>
100+
101+
102+
103+
</div><div id="footer">
104+
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>. <br/>This documentation is built using <a href="https://github.com/JetBrains/phpstorm-stubs#readme" rel="noreferrer noopener" target="_blank">phpstorm-stubs</a> from JetBrains.</div></div>
105+
</div>
106+
</body>
107+
108+
</html>
Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="robots" content="index, follow, all" />
6+
<title>JsonPath\JsonPath | PHP Jetbrains phpstorm-stubs</title>
7+
8+
<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">
9+
<link rel="stylesheet" type="text/css" href="../css/bootstrap-theme.min.css">
10+
<link rel="stylesheet" type="text/css" href="../css/doctum.css">
11+
<link rel="stylesheet" type="text/css" href="../fonts/doctum-font.css">
12+
<script src="../js/jquery-3.5.1.slim.min.js"></script>
13+
<script async defer src="../doctum.js"></script>
14+
<script async defer src="../js/bootstrap.min.js"></script>
15+
<script async defer src="../js/autocomplete.min.js"></script>
16+
<meta name="MobileOptimized" content="width">
17+
<meta name="HandheldFriendly" content="true">
18+
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
19+
20+
</head>
21+
22+
<body id="class" data-name="class:JsonPath_JsonPath" data-root-path="../" data-search-index-url="../doctum-search.json">
23+
<div id="content">
24+
<div id="left-column">
25+
<div id="control-panel">
26+
<div class="search-bar hidden" id="search-progress-bar-container">
27+
<div class="progress">
28+
<div class="progress-bar" role="progressbar" id="search-progress-bar"
29+
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
30+
</div>
31+
</div>
32+
<form id="search-form" action="../search.html">
33+
<span class="icon icon-search"></span>
34+
<input name="search"
35+
id="doctum-search-auto-complete"
36+
class="typeahead form-control"
37+
type="search"
38+
placeholder="Search"
39+
spellcheck="false"
40+
autocorrect="off"
41+
autocomplete="off"
42+
autocapitalize="off">
43+
<div class="auto-complete-results" id="auto-complete-results"></div>
44+
</form>
45+
</div>
46+
47+
<div id="api-tree"></div>
48+
49+
</div>
50+
<div id="right-column">
51+
<nav id="site-nav" class="navbar navbar-default" role="navigation">
52+
<div class="container-fluid">
53+
<div class="navbar-header">
54+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
55+
<span class="sr-only">Toggle navigation</span>
56+
<span class="icon-bar"></span>
57+
<span class="icon-bar"></span>
58+
<span class="icon-bar"></span>
59+
</button>
60+
<a class="navbar-brand" href="../index.html">PHP Jetbrains phpstorm-stubs</a>
61+
</div>
62+
<div class="collapse navbar-collapse" id="navbar-elements">
63+
<ul class="nav navbar-nav">
64+
<li><a href="../classes.html">Classes</a></li>
65+
<li><a href="../namespaces.html">Namespaces</a></li>
66+
<li><a href="../interfaces.html">Interfaces</a></li>
67+
<li><a href="../traits.html">Traits</a></li>
68+
<li><a href="../doc-index.html">Index</a></li>
69+
<li><a href="../search.html">Search</a></li>
70+
</ul>
71+
</div>
72+
</div>
73+
</nav>
74+
75+
<div class="namespace-breadcrumbs">
76+
<ol class="breadcrumb">
77+
<li><span class="label label-default">class</span></li>
78+
<li><a href="../JsonPath.html">JsonPath</a></li><li class="backslash">\</li><li>JsonPath</li>
79+
</ol>
80+
</div>
81+
<div id="page-content">
82+
<div class="page-header">
83+
<h1>JsonPath
84+
</h1>
85+
</div>
86+
87+
<i>Since: 7.4</i>
88+
<br>
89+
90+
<p> class
91+
<strong>JsonPath</strong> (<a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/jsonpath/jsonpath.php">View source</a>)
92+
</p>
93+
94+
95+
96+
97+
98+
99+
100+
101+
102+
<h2>Methods</h2>
103+
104+
<div class="container-fluid underlined">
105+
<div class="row">
106+
<div class="col-md-2 type">
107+
<abbr title="JsonPath\array|false">array|false</abbr>
108+
</div>
109+
<div class="col-md-8">
110+
<a href="#method_find">find</a>(array $data, string $expression)
111+
112+
<p class="no-description">No description</p>
113+
</div>
114+
<div class="col-md-2"></div>
115+
</div>
116+
</div>
117+
118+
119+
<h2>Details</h2>
120+
121+
<div id="method-details">
122+
<div class="method-item">
123+
<h3 id="method_find">
124+
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/jsonpath/jsonpath.php#L23">at line 23</a></div>
125+
<code> <abbr title="JsonPath\array|false">array|false</abbr>
126+
<strong>find</strong>(array $data, string $expression)
127+
</code>
128+
</h3>
129+
<div class="details"><i>Since: 7.4</i>
130+
<br>
131+
132+
133+
134+
<div class="method-description">
135+
<p class="no-description">No description</p>
136+
137+
</div>
138+
<div class="tags">
139+
<h4>Parameters</h4>
140+
141+
<table class="table table-condensed">
142+
<tr>
143+
<td>array</td>
144+
<td>$data</td>
145+
<td></td>
146+
</tr>
147+
<tr>
148+
<td>string</td>
149+
<td>$expression</td>
150+
<td></td>
151+
</tr>
152+
</table>
153+
154+
155+
<h4>Return Value</h4>
156+
157+
<table class="table table-condensed">
158+
<tr>
159+
<td><abbr title="JsonPath\array|false">array|false</abbr></td>
160+
<td><p>an array on success or <b>FALSE</b> on failure (not found).</p></td>
161+
</tr>
162+
</table>
163+
164+
165+
<h4>Exceptions</h4>
166+
167+
<table class="table table-condensed">
168+
<tr>
169+
<td><a href="../JsonPath/JsonPathException.html"><abbr title="JsonPath\JsonPathException">JsonPathException</abbr></a></td>
170+
<td></td>
171+
</tr>
172+
</table>
173+
174+
175+
176+
</div>
177+
</div>
178+
179+
</div>
180+
</div>
181+
182+
183+
</div><div id="footer">
184+
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>. <br/>This documentation is built using <a href="https://github.com/JetBrains/phpstorm-stubs#readme" rel="noreferrer noopener" target="_blank">phpstorm-stubs</a> from JetBrains.</div></div>
185+
</div>
186+
</body>
187+
188+
</html>

0 commit comments

Comments
 (0)