Skip to content

Commit

Permalink
Api documentations update (Mon Jan 13 12:19:44 UTC 2025)
Browse files Browse the repository at this point in the history 
#apidocs
  • Loading branch information
@sudo-robot
sudo-robot committed Jan 13, 2025
1 parent 9ae7684 commit b1cb71d
Show file tree
Hide file tree
Showing 13 changed files with 952 additions and 8 deletions.
108 changes: 108 additions & 0 deletions api-docs/phpstorm-stubs/JsonPath.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>JsonPath | PHP Jetbrains phpstorm-stubs</title>

<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
<script src="js/jquery-3.5.1.slim.min.js"></script>
<script async defer src="doctum.js"></script>
<script async defer src="js/bootstrap.min.js"></script>
<script async defer src="js/autocomplete.min.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">

</head>

<body id="namespace" data-name="namespace:JsonPath" data-root-path="" data-search-index-url="doctum-search.json">
<div id="content">
<div id="left-column">
<div id="control-panel">
<div class="search-bar hidden" id="search-progress-bar-container">
<div class="progress">
<div class="progress-bar" role="progressbar" id="search-progress-bar"
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
</div>
</div>
<form id="search-form" action="search.html">
<span class="icon icon-search"></span>
<input name="search"
id="doctum-search-auto-complete"
class="typeahead form-control"
type="search"
placeholder="Search"
spellcheck="false"
autocorrect="off"
autocomplete="off"
autocapitalize="off">
<div class="auto-complete-results" id="auto-complete-results"></div>
</form>
</div>

<div id="api-tree"></div>

</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">PHP Jetbrains phpstorm-stubs</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="classes.html">Classes</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="interfaces.html">Interfaces</a></li>
<li><a href="traits.html">Traits</a></li>
<li><a href="doc-index.html">Index</a></li>
<li><a href="search.html">Search</a></li>
</ul>
</div>
</div>
</nav>

<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">Namespace</span></li>
<li><a href="JsonPath.html">JsonPath</a></li><li class="backslash">\</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>JsonPath</h1>
</div>


<h2>Classes</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<a href="JsonPath/JsonPath.html"><abbr title="JsonPath\JsonPath">JsonPath</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="JsonPath/JsonPathException.html"><abbr title="JsonPath\JsonPathException">JsonPathException</abbr></a> </div>
<div class="col-md-6"></div>
</div>
</div>



</div><div id="footer">
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>
</div>
</body>

</html>
188 changes: 188 additions & 0 deletions api-docs/phpstorm-stubs/JsonPath/JsonPath.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>JsonPath\JsonPath | PHP Jetbrains phpstorm-stubs</title>

<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../css/doctum.css">
<link rel="stylesheet" type="text/css" href="../fonts/doctum-font.css">
<script src="../js/jquery-3.5.1.slim.min.js"></script>
<script async defer src="../doctum.js"></script>
<script async defer src="../js/bootstrap.min.js"></script>
<script async defer src="../js/autocomplete.min.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">

</head>

<body id="class" data-name="class:JsonPath_JsonPath" data-root-path="../" data-search-index-url="../doctum-search.json">
<div id="content">
<div id="left-column">
<div id="control-panel">
<div class="search-bar hidden" id="search-progress-bar-container">
<div class="progress">
<div class="progress-bar" role="progressbar" id="search-progress-bar"
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
</div>
</div>
<form id="search-form" action="../search.html">
<span class="icon icon-search"></span>
<input name="search"
id="doctum-search-auto-complete"
class="typeahead form-control"
type="search"
placeholder="Search"
spellcheck="false"
autocorrect="off"
autocomplete="off"
autocapitalize="off">
<div class="auto-complete-results" id="auto-complete-results"></div>
</form>
</div>

<div id="api-tree"></div>

</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">PHP Jetbrains phpstorm-stubs</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../classes.html">Classes</a></li>
<li><a href="../namespaces.html">Namespaces</a></li>
<li><a href="../interfaces.html">Interfaces</a></li>
<li><a href="../traits.html">Traits</a></li>
<li><a href="../doc-index.html">Index</a></li>
<li><a href="../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>

<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">class</span></li>
<li><a href="../JsonPath.html">JsonPath</a></li><li class="backslash">\</li><li>JsonPath</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>JsonPath
</h1>
</div>

<i>Since: 7.4</i>
<br>

<p> class
<strong>JsonPath</strong> (<a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/jsonpath/jsonpath.php">View source</a>)
</p>









<h2>Methods</h2>

<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
<abbr title="JsonPath\array|false">array|false</abbr>
</div>
<div class="col-md-8">
<a href="#method_find">find</a>(array $data, string $expression)

<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
</div>


<h2>Details</h2>

<div id="method-details">
<div class="method-item">
<h3 id="method_find">
<div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/jsonpath/jsonpath.php#L23">at line 23</a></div>
<code> <abbr title="JsonPath\array|false">array|false</abbr>
<strong>find</strong>(array $data, string $expression)
</code>
</h3>
<div class="details"><i>Since: 7.4</i>
<br>



<div class="method-description">
<p class="no-description">No description</p>

</div>
<div class="tags">
<h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td>array</td>
<td>$data</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$expression</td>
<td></td>
</tr>
</table>


<h4>Return Value</h4>

<table class="table table-condensed">
<tr>
<td><abbr title="JsonPath\array|false">array|false</abbr></td>
<td><p>an array on success or <b>FALSE</b> on failure (not found).</p></td>
</tr>
</table>


<h4>Exceptions</h4>

<table class="table table-condensed">
<tr>
<td><a href="../JsonPath/JsonPathException.html"><abbr title="JsonPath\JsonPathException">JsonPathException</abbr></a></td>
<td></td>
</tr>
</table>



</div>
</div>

</div>
</div>


</div><div id="footer">
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>
</div>
</body>

</html>
Loading

0 comments on commit b1cb71d

Please sign in to comment.