Skip to content

Commit

Permalink
phpdoc generation for version: 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@zbateson
zbateson committed Mar 2, 2024
1 parent 478a16d commit 4db8730
Show file tree
Hide file tree
Showing 238 changed files with 187,172 additions and 0 deletions.
809 changes: 809 additions & 0 deletions api/3.0/classes/ZBateson-MailMimeParser-Error.html
View file

Large diffs are not rendered by default.

893 changes: 893 additions & 0 deletions api/3.0/classes/ZBateson-MailMimeParser-ErrorBag.html
View file

Large diffs are not rendered by default.

1,685 changes: 1,685 additions & 0 deletions api/3.0/classes/ZBateson-MailMimeParser-Header-AbstractHeader.html
View file

Large diffs are not rendered by default.

1,979 changes: 1,979 additions & 0 deletions api/3.0/classes/ZBateson-MailMimeParser-Header-AddressHeader.html
View file

Large diffs are not rendered by default.

1,337 changes: 1,337 additions & 0 deletions api/3.0/classes/ZBateson-MailMimeParser-Header-Consumer-AbstractConsumerService.html
View file

Large diffs are not rendered by default.

1,658 changes: 1,658 additions & 0 deletions api/3.0/classes/ZBateson-MailMimeParser-Header-Consumer-AbstractGenericConsumerService.html
View file

Large diffs are not rendered by default.

1,339 changes: 1,339 additions & 0 deletions api/3.0/classes/ZBateson-MailMimeParser-Header-Consumer-AddressBaseConsumerService.html
View file

Large diffs are not rendered by default.

1,358 changes: 1,358 additions & 0 deletions api/3.0/classes/ZBateson-MailMimeParser-Header-Consumer-AddressConsumerService.html
View file

Large diffs are not rendered by default.

1,324 changes: 1,324 additions & 0 deletions api/3.0/classes/ZBateson-MailMimeParser-Header-Consumer-AddressEmailConsumerService.html
View file

Large diffs are not rendered by default.

1,362 changes: 1,362 additions & 0 deletions api/3.0/classes/ZBateson-MailMimeParser-Header-Consumer-AddressGroupConsumerService.html
View file

Large diffs are not rendered by default.

1,637 changes: 1,637 additions & 0 deletions api/3.0/classes/ZBateson-MailMimeParser-Header-Consumer-CommentConsumerService.html
View file

Large diffs are not rendered by default.

1,642 changes: 1,642 additions & 0 deletions api/3.0/classes/ZBateson-MailMimeParser-Header-Consumer-DateConsumerService.html
View file

Large diffs are not rendered by default.

1,661 changes: 1,661 additions & 0 deletions ...lasses/ZBateson-MailMimeParser-Header-Consumer-GenericConsumerMimeLiteralPartService.html
View file

Large diffs are not rendered by default.

1,662 changes: 1,662 additions & 0 deletions api/3.0/classes/ZBateson-MailMimeParser-Header-Consumer-GenericConsumerService.html
View file

Large diffs are not rendered by default.

303 changes: 303 additions & 0 deletions api/3.0/classes/ZBateson-MailMimeParser-Header-Consumer-IConsumerService.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,303 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>MailMimeParser 3.0</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 rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@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/[email protected]/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></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">MailMimeParser 3.0</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/zbateson.html" class="">ZBateson</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/zbateson-mailmimeparser.html" class="">MailMimeParser</a>

</li>
</ul>

</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/MailMimeParser.html" class="">MailMimeParser</a>
</h4>

</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/zbateson.html">ZBateson</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/zbateson-mailmimeparser.html">MailMimeParser</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/zbateson-mailmimeparser-header.html">Header</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/zbateson-mailmimeparser-header-consumer.html">Consumer</a></li>
</ul>

<article class="phpdocumentor-element -interface">
<h2 class="phpdocumentor-content__title">
IConsumerService
<div class="phpdocumentor-element__package">
in
<ul class="phpdocumentor-breadcrumbs">
<li><a href="packages/MailMimeParser.html">MailMimeParser</a></li>
</ul>
</div>
</h2>

<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Header/Consumer/IConsumerService.php"><a href="files/header-consumer-iconsumerservice.html"><abbr title="Header/Consumer/IConsumerService.php">IConsumerService.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">16</span>

</aside>

<p class="phpdocumentor-summary">Interface defining a consumer service class.</p>



<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">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">

<section class="phpdocumentor-description"><p>Zaahid Bateson</p>
</section>

</dd>
</dl>






<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/ZBateson-MailMimeParser-Header-Consumer-IConsumerService.html#method___invoke">__invoke()</a>
<span>
&nbsp;: array&lt;string|int, <a href="classes/ZBateson-MailMimeParser-Header-IHeaderPart.html"><abbr title="\ZBateson\MailMimeParser\Header\IHeaderPart">IHeaderPart</abbr></a>&gt; </span>
</dt>
<dd>Invokes parsing of a header&#039;s value into header parts.</dd>

</dl>





<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/ZBateson-MailMimeParser-Header-Consumer-IConsumerService.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___invoke">
__invoke()
<a href="classes/ZBateson-MailMimeParser-Header-Consumer-IConsumerService.html#method___invoke" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Header/Consumer/IConsumerService.php"><a href="files/header-consumer-iconsumerservice.html"><abbr title="Header/Consumer/IConsumerService.php">IConsumerService.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>

</aside>

<p class="phpdocumentor-summary">Invokes parsing of a header&#039;s value into header parts.</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__invoke</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/ZBateson-MailMimeParser-Header-IHeaderPart.html"><abbr title="\ZBateson\MailMimeParser\Header\IHeaderPart">IHeaderPart</abbr></a>&gt;</span></code>


<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>the raw header value</p>
</section>

</dd>
</dl>



<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/ZBateson-MailMimeParser-Header-IHeaderPart.html"><abbr title="\ZBateson\MailMimeParser\Header\IHeaderPart">IHeaderPart</abbr></a>&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>the array of parsed
parts</p>
</section>


</article>
</section>


<script type="text/javascript">
function loadExternalCodeSnippets(line) {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';

var code = document.createElement('code');
code.className = 'language-' + language;

pre.textContent = '';

pre.setAttribute('data-line', line)
code.textContent = 'Loading…';

pre.appendChild(code);

var xhr = new XMLHttpRequest();

xhr.open('GET', src, true);

xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {

if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;

Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
}
}
};

xhr.send(null);
});
}

var modals = document.querySelectorAll("[data-modal]");

modals.forEach(function (trigger) {
trigger.addEventListener("click", function (event) {
//event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippets(trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
</script>

</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/ZBateson-MailMimeParser-Header-Consumer-IConsumerService.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/[email protected]/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>
Loading

0 comments on commit 4db8730

Please sign in to comment.