Skip to content

Fix types #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Mar 18, 2021
Merged

Fix types #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
98eaee9
Fix require paths
ngmy Mar 18, 2021
89d1d6f
Fix types
ngmy Mar 18, 2021
216630a
Fix to call the method only when necessary
ngmy Mar 18, 2021
bf27044
Add the test
ngmy Mar 18, 2021
162f5d5
Add the PHPStan example
ngmy Mar 18, 2021
2d5f313
Update tools
ngmy Mar 18, 2021
599d176
Generate the API documentation
ngmy Mar 18, 2021
d63b587
Add test cases to increase coverage
ngmy Mar 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .phive/phars.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<phive xmlns="https://phar.io/phive">
<phar name="php-coveralls" version="^2.4.3" installed="2.4.3" location="./tools/php-coveralls" copy="false"/>
<phar name="php-cs-fixer" version="^2.18.2" installed="2.18.2" location="./tools/php-cs-fixer" copy="false"/>
<phar name="php-cs-fixer" version="^2.18.2" installed="2.18.3" location="./tools/php-cs-fixer" copy="false"/>
<phar name="phpcbf" version="^3.5.8" installed="3.5.8" location="./tools/phpcbf" copy="false"/>
<phar name="phpcs" version="^3.5.8" installed="3.5.8" location="./tools/phpcs" copy="false"/>
<phar name="phpdocumentor" version="^3.0.0" installed="3.0.0" location="./tools/phpDocumentor" copy="false"/>
<phar name="phpstan" version="^0.12.64" installed="0.12.80" location="./tools/phpstan" copy="false"/>
<phar name="phpunit" version="^9.5.0" installed="9.5.2" location="./tools/phpunit" copy="false"/>
<phar name="phpstan" version="^0.12.64" installed="0.12.81" location="./tools/phpstan" copy="false"/>
<phar name="phpunit" version="^9.5.0" installed="9.5.3" location="./tools/phpunit" copy="false"/>
</phive>
190 changes: 190 additions & 0 deletions docs/api/classes/Ngmy-TypedArray-Tests-TypedArrayIntKeyTest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<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" />
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>

<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>

<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">

<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/ngmy.html"><abbr title="\Ngmy">Ngmy</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/ngmy-typedarray.html"><abbr title="\Ngmy\TypedArray">TypedArray</abbr></a></li>
</ul>
</section>


<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>

<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>

<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/ngmy.html">Ngmy</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/ngmy-typedarray.html">TypedArray</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/ngmy-typedarray-tests.html">Tests</a></li>
</ul>

<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
TypedArrayIntKeyTest

<span class="phpdocumentor-element__extends">
extends <a href="classes/Ngmy-TypedArray-Tests-TestCase.html"><abbr title="\Ngmy\TypedArray\Tests\TestCase">TestCase</abbr></a>
</span>



</h2>

<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/TypedArrayIntKeyTest.php"><a href="files/tests-typedarrayintkeytest.html"><abbr title="tests/TypedArrayIntKeyTest.php">TypedArrayIntKeyTest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">9</span>
</aside>










<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>

<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Ngmy-TypedArray-Tests-TypedArrayIntKeyTest.html#method_testAssignValue">testAssignValue()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>

</dl>







<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/Ngmy-TypedArray-Tests-TypedArrayIntKeyTest.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_testAssignValue">
testAssignValue()
<a href="classes/Ngmy-TypedArray-Tests-TypedArrayIntKeyTest.html#method_testAssignValue" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/TypedArrayIntKeyTest.php"><a href="files/tests-typedarrayintkeytest.html"><abbr title="tests/TypedArrayIntKeyTest.php">TypedArrayIntKeyTest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>


<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">testAssignValue</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>





<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>


</article>
</section>

</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="classes/Ngmy-TypedArray-Tests-TypedArrayIntKeyTest.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>

</main>

<script>
cssVars({});
</script>
</body>
</html>
66 changes: 12 additions & 54 deletions docs/api/classes/Ngmy-TypedArray-TypedArray.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ <h3 id="toc">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Ngmy-TypedArray-TypedArray.html#method_withIntKey">withIntKey()</a>
<span>
&nbsp;: <a href="classes/Ngmy-TypedArray-TypedArray.html"><abbr title="\Ngmy\TypedArray\TypedArray">TypedArray</abbr></a>&lt;int, mixed&gt; </span>
&nbsp;: <a href="classes/Ngmy-TypedArray-TypedArray.html"><abbr title="\Ngmy\TypedArray\TypedArray">TypedArray</abbr></a>&lt;int|null, mixed&gt; </span>
</dt>
<dd>Returns a new instance of the typed array with the int type key.</dd>

Expand Down Expand Up @@ -891,7 +891,7 @@ <h4 class="phpdocumentor-element__name" id="method_count">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TypedArray.php"><a href="files/src-typedarray.html"><abbr title="src/TypedArray.php">TypedArray.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">638</span>
<span class="phpdocumentor-element-found-in__line">635</span>
</aside>


Expand Down Expand Up @@ -939,7 +939,7 @@ <h4 class="phpdocumentor-element__name" id="method_getIterator">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TypedArray.php"><a href="files/src-typedarray.html"><abbr title="src/TypedArray.php">TypedArray.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">649</span>
<span class="phpdocumentor-element-found-in__line">646</span>
</aside>


Expand Down Expand Up @@ -1064,7 +1064,7 @@ <h4 class="phpdocumentor-element__name" id="method_offsetExists">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TypedArray.php"><a href="files/src-typedarray.html"><abbr title="src/TypedArray.php">TypedArray.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">557</span>
<span class="phpdocumentor-element-found-in__line">555</span>
</aside>


Expand Down Expand Up @@ -1100,15 +1100,6 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">

<section class="phpdocumentor-description"></section>

</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">phpstan-param</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">

<section class="phpdocumentor-description"><p>TKey $key</p>
</section>

</dd>
</dl>

Expand All @@ -1132,7 +1123,7 @@ <h4 class="phpdocumentor-element__name" id="method_offsetGet">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TypedArray.php"><a href="files/src-typedarray.html"><abbr title="src/TypedArray.php">TypedArray.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">570</span>
<span class="phpdocumentor-element-found-in__line">567</span>
</aside>


Expand Down Expand Up @@ -1168,15 +1159,6 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">

<section class="phpdocumentor-description"></section>

</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">phpstan-param</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">

<section class="phpdocumentor-description"><p>TKey $key</p>
</section>

</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">phpstan-return</span>
Expand Down Expand Up @@ -1209,7 +1191,7 @@ <h4 class="phpdocumentor-element__name" id="method_offsetSet">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TypedArray.php"><a href="files/src-typedarray.html"><abbr title="src/TypedArray.php">TypedArray.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">583</span>
<span class="phpdocumentor-element-found-in__line">580</span>
</aside>


Expand Down Expand Up @@ -1294,7 +1276,7 @@ <h4 class="phpdocumentor-element__name" id="method_offsetUnset">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TypedArray.php"><a href="files/src-typedarray.html"><abbr title="src/TypedArray.php">TypedArray.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">628</span>
<span class="phpdocumentor-element-found-in__line">623</span>
</aside>


Expand Down Expand Up @@ -1330,15 +1312,6 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">

<section class="phpdocumentor-description"></section>

</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">phpstan-param</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">

<section class="phpdocumentor-description"><p>TKey $key</p>
</section>

</dd>
</dl>

Expand Down Expand Up @@ -1995,7 +1968,7 @@ <h4 class="phpdocumentor-element__name" id="method_withIntKey">

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">withIntKey</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Ngmy-TypedArray-TypedArray.html"><abbr title="\Ngmy\TypedArray\TypedArray">TypedArray</abbr></a>&lt;int, mixed&gt;</span></code>
<span class="phpdocumentor-signature__name">withIntKey</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Ngmy-TypedArray-TypedArray.html"><abbr title="\Ngmy\TypedArray\TypedArray">TypedArray</abbr></a>&lt;int|null, mixed&gt;</span></code>

<section class="phpdocumentor-description"></section>

Expand All @@ -2011,14 +1984,14 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
</dt>
<dd class="phpdocumentor-tag-list__definition">

<section class="phpdocumentor-description"><p>TypedArray&lt;int, TValue&gt;</p>
<section class="phpdocumentor-description"><p>TypedArray&lt;int|null, TValue&gt;</p>
</section>

</dd>
</dl>

<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Ngmy-TypedArray-TypedArray.html"><abbr title="\Ngmy\TypedArray\TypedArray">TypedArray</abbr></a>&lt;int, mixed&gt;</span>
<span class="phpdocumentor-signature__response_type"><a href="classes/Ngmy-TypedArray-TypedArray.html"><abbr title="\Ngmy\TypedArray\TypedArray">TypedArray</abbr></a>&lt;int|null, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"></section>

Expand Down Expand Up @@ -2620,7 +2593,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TypedArray.php"><a href="files/src-typedarray.html"><abbr title="src/TypedArray.php">TypedArray.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">654</span>
<span class="phpdocumentor-element-found-in__line">651</span>
</aside>


Expand Down Expand Up @@ -2683,7 +2656,7 @@ <h4 class="phpdocumentor-element__name" id="method_getKeyHashCode">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TypedArray.php"><a href="files/src-typedarray.html"><abbr title="src/TypedArray.php">TypedArray.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">672</span>
<span class="phpdocumentor-element-found-in__line">667</span>
</aside>


Expand All @@ -2706,21 +2679,6 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
</dl>


<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">phpstan-param</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">

<section class="phpdocumentor-description"><p>TKey $key</p>
</section>

</dd>
</dl>

<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int|string|null</span>
Expand Down
Loading