mirror of
https://github.com/chillerlan/php-qrcode.git
synced 2026-08-24 12:57:53 +00:00
833 lines
37 KiB
HTML
833 lines
37 KiB
HTML
<!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" type="image/png" sizes="32x32" href="images/favicon-32x32.png"/>
|
|
<link rel="icon" type="image/png" sizes="16x16" href="images/favicon-16x16.png"/>
|
|
<link rel="icon" href="images/favicon.ico"/>
|
|
<link rel="apple-touch-icon" href="images/apple-touch-icon.png"/>
|
|
<link rel="stylesheet" href="css/normalize.css">
|
|
<link rel="stylesheet" href="css/base.css">
|
|
<link rel="preconnect" href="https://fonts.gstatic.com">
|
|
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
|
|
<link href="https://fonts.googleapis.com/css2?family=Source+Code+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" />
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
|
|
<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="js/template.js"></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">
|
|
<li class="phpdocumentor-topnav__menu-item -menu">
|
|
<a href="https://php-qrcode.readthedocs.io">
|
|
<span>
|
|
User Manual
|
|
</span>
|
|
</a>
|
|
</li>
|
|
<li class="phpdocumentor-topnav__menu-item -social">
|
|
<a href="https://github.com/chillerlan/php-qrcode">
|
|
<span>
|
|
<i class="fab fa-github"></i>
|
|
|
|
</span>
|
|
</a>
|
|
</li>
|
|
<li class="phpdocumentor-topnav__menu-item -social">
|
|
<a href="https://github.com/chillerlan/php-qrcode/discussions">
|
|
<span>
|
|
<i class="fas fa-envelope-open-text"></i>
|
|
|
|
</span>
|
|
</a>
|
|
</li>
|
|
</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 -three phpdocumentor-sidebar">
|
|
<section class="phpdocumentor-sidebar__category -namespaces">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/chillerlan.html" class="">chillerlan</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
</section>
|
|
<section class="phpdocumentor-sidebar__category -packages">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/Application.html" class="">Application</a>
|
|
</h4>
|
|
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category -reports">
|
|
<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 -indices">
|
|
<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 -nine phpdocumentor-content">
|
|
<section>
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a></li>
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -class">
|
|
<h2 class="phpdocumentor-content__title">
|
|
QROptionsTest
|
|
|
|
<span class="phpdocumentor-element__extends">
|
|
extends <abbr title="\PHPUnit\Framework\TestCase">TestCase</abbr>
|
|
</span>
|
|
|
|
<div class="phpdocumentor-element__package">
|
|
in package
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
<li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</h2>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
|
|
<div class="phpdocumentor-label phpdocumentor-label--success"><span>Final</span><span>Yes</span></div>
|
|
|
|
|
|
</div>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="tests/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">24</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">QROptions test</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="toc">
|
|
Table of Contents
|
|
<a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 id="toc-methods">
|
|
Methods
|
|
<a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_clampCircleRadius">clampCircleRadius()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Tests clamping of the circle radius</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_clampLogoSpaceValue">clampLogoSpaceValue()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Tests the clamping (between 0 and 177) of the logo space values</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_logoSpaceStartNullable">logoSpaceStartNullable()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Tests if the optional logo space start values are nullable</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_setEccLevel">setEccLevel()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Tests setting the ECC level from string or int</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_setEccLevelFromIntException">setEccLevelFromIntException()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Tests if an exception is thrown when attempting to set an invalid ECC level integer</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_setEccLevelFromStringException">setEccLevelFromStringException()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Tests if an exception is thrown when attempting to set an invalid ECC level string</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_versionClamp">versionClamp()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Tests the $version clamping</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-methods">
|
|
<h3 class="phpdocumentor-elements__header" id="methods">
|
|
Methods
|
|
<a href="classes/chillerlan-QRCodeTest-QROptionsTest.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_clampCircleRadius">
|
|
clampCircleRadius()
|
|
<a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_clampCircleRadius" 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/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">119</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Tests clamping of the circle radius</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">clampCircleRadius</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__type">float </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__type">float </span><span class="phpdocumentor-signature__argument__name">$expected</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-argument-list__argument__name">$value</span>
|
|
: <span class="phpdocumentor-argument-list__argument__type">float</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-argument-list__argument__name">$expected</span>
|
|
: <span class="phpdocumentor-argument-list__argument__type">float</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-attributes">
|
|
<h5 class="phpdocumentor-elements__header" id="method_clampCircleRadius_attributes">
|
|
Attributes <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_clampCircleRadius_attributes" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\Test">Test</abbr>]
|
|
</dt>
|
|
</dl>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\TestWith">TestWith</abbr>]
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
[0.0, 0.1]
|
|
</dd>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
'min'
|
|
</dd>
|
|
</dl>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\TestWith">TestWith</abbr>]
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
[0.5, 0.5]
|
|
</dd>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
'no clamp'
|
|
</dd>
|
|
</dl>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\TestWith">TestWith</abbr>]
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
[1.5, 0.75]
|
|
</dd>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
'max'
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_clampLogoSpaceValue">
|
|
clampLogoSpaceValue()
|
|
<a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_clampLogoSpaceValue" 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/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">80</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Tests the clamping (between 0 and 177) of the logo space values</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">clampLogoSpaceValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__type">int </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__type">int </span><span class="phpdocumentor-signature__argument__name">$expected</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-argument-list__argument__name">$value</span>
|
|
: <span class="phpdocumentor-argument-list__argument__type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-argument-list__argument__name">$expected</span>
|
|
: <span class="phpdocumentor-argument-list__argument__type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-attributes">
|
|
<h5 class="phpdocumentor-elements__header" id="method_clampLogoSpaceValue_attributes">
|
|
Attributes <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_clampLogoSpaceValue_attributes" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\Test">Test</abbr>]
|
|
</dt>
|
|
</dl>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\TestWith">TestWith</abbr>]
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
[-1, 0]
|
|
</dd>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
'negative'
|
|
</dd>
|
|
</dl>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\TestWith">TestWith</abbr>]
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
[0, 0]
|
|
</dd>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
'zero'
|
|
</dd>
|
|
</dl>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\TestWith">TestWith</abbr>]
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
[69, 69]
|
|
</dd>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
'normal'
|
|
</dd>
|
|
</dl>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\TestWith">TestWith</abbr>]
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
[177, 177]
|
|
</dd>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
'max'
|
|
</dd>
|
|
</dl>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\TestWith">TestWith</abbr>]
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
[178, 177]
|
|
</dd>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
'exceed'
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_logoSpaceStartNullable">
|
|
logoSpaceStartNullable()
|
|
<a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_logoSpaceStartNullable" 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/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">99</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Tests if the optional logo space start values are nullable</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">logoSpaceStartNullable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-attributes">
|
|
<h5 class="phpdocumentor-elements__header" id="method_logoSpaceStartNullable_attributes">
|
|
Attributes <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_logoSpaceStartNullable_attributes" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\Test">Test</abbr>]
|
|
</dt>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setEccLevel">
|
|
setEccLevel()
|
|
<a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_setEccLevel" 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/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">45</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Tests setting the ECC level from string or int</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setEccLevel</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="method_setEccLevel_tags">
|
|
Tags
|
|
<a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_setEccLevel_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">phan-suppress</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<section class="phpdocumentor-description"><p>PhanTypeMismatchPropertyReal</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<section class="phpdocumentor-attributes">
|
|
<h5 class="phpdocumentor-elements__header" id="method_setEccLevel_attributes">
|
|
Attributes <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_setEccLevel_attributes" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\Test">Test</abbr>]
|
|
</dt>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setEccLevelFromIntException">
|
|
setEccLevelFromIntException()
|
|
<a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_setEccLevelFromIntException" 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/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">58</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Tests if an exception is thrown when attempting to set an invalid ECC level integer</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setEccLevelFromIntException</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-attributes">
|
|
<h5 class="phpdocumentor-elements__header" id="method_setEccLevelFromIntException_attributes">
|
|
Attributes <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_setEccLevelFromIntException_attributes" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\Test">Test</abbr>]
|
|
</dt>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setEccLevelFromStringException">
|
|
setEccLevelFromStringException()
|
|
<a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_setEccLevelFromStringException" 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/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">69</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Tests if an exception is thrown when attempting to set an invalid ECC level string</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setEccLevelFromStringException</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-attributes">
|
|
<h5 class="phpdocumentor-elements__header" id="method_setEccLevelFromStringException_attributes">
|
|
Attributes <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_setEccLevelFromStringException_attributes" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\Test">Test</abbr>]
|
|
</dt>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_versionClamp">
|
|
versionClamp()
|
|
<a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_versionClamp" 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/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">29</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Tests the $version clamping</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">versionClamp</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__type">int </span><span class="phpdocumentor-signature__argument__name">$version</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__type">int </span><span class="phpdocumentor-signature__argument__name">$expected</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-argument-list__argument__name">$version</span>
|
|
: <span class="phpdocumentor-argument-list__argument__type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-argument-list__argument__name">$expected</span>
|
|
: <span class="phpdocumentor-argument-list__argument__type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-attributes">
|
|
<h5 class="phpdocumentor-elements__header" id="method_versionClamp_attributes">
|
|
Attributes <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_versionClamp_attributes" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\Test">Test</abbr>]
|
|
</dt>
|
|
</dl>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\TestWith">TestWith</abbr>]
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
[42, 40]
|
|
</dd>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
'values > 40 should be clamped to 40'
|
|
</dd>
|
|
</dl>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\TestWith">TestWith</abbr>]
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
[-42, 1]
|
|
</dd>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
'values < 1 should be clamped to 1'
|
|
</dd>
|
|
</dl>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\TestWith">TestWith</abbr>]
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
[21, 21]
|
|
</dd>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
'values in between should not be touched'
|
|
</dd>
|
|
</dl>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
#[<abbr title="\PHPUnit\Framework\Attributes\TestWith">TestWith</abbr>]
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
[Version::AUTO, -1]
|
|
</dd>
|
|
<dd class="phpdocumentor-argument-list__entry">
|
|
'value -1 should be treated as is (default)'
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
</section>
|
|
<section class="phpdocumentor-on-this-page__sidebar">
|
|
|
|
<section class="phpdocumentor-on-this-page__content">
|
|
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
|
|
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#toc-methods">Methods</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li class=""><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_clampCircleRadius">clampCircleRadius()</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_clampLogoSpaceValue">clampLogoSpaceValue()</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_logoSpaceStartNullable">logoSpaceStartNullable()</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_setEccLevel">setEccLevel()</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_setEccLevelFromIntException">setEccLevelFromIntException()</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_setEccLevelFromStringException">setEccLevelFromStringException()</a></li>
|
|
<li class=""><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_versionClamp">versionClamp()</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
|
|
</section>
|
|
</div>
|
|
<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>
|
|
<a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
|
</main>
|
|
|
|
<script>
|
|
cssVars({});
|
|
</script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
|
|
</body>
|
|
</html>
|