1013 lines
56 KiB
HTML
1013 lines
56 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" 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/taproot.html"><abbr title="\Taproot">Taproot</abbr></a></h4>
|
|||
|
<ul class="phpdocumentor-list">
|
|||
|
<li><a href="namespaces/taproot-indieauth.html"><abbr title="\Taproot\IndieAuth">IndieAuth</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/taproot.html">Taproot</a></li>
|
|||
|
</ul>
|
|||
|
|
|||
|
<article class="phpdocumentor-element -namespace">
|
|||
|
<h2 class="phpdocumentor-content__title">IndieAuth</h2>
|
|||
|
|
|||
|
|
|||
|
<h3 id="namespaces">
|
|||
|
Namespaces
|
|||
|
<a href="#namespaces" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h3>
|
|||
|
|
|||
|
<dl class="phpdocumentor-table-of-contents">
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/taproot-indieauth-callback.html"><abbr title="\Taproot\IndieAuth\Callback">Callback</abbr></a></dt>
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/taproot-indieauth-middleware.html"><abbr title="\Taproot\IndieAuth\Middleware">Middleware</abbr></a></dt>
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/taproot-indieauth-storage.html"><abbr title="\Taproot\IndieAuth\Storage">Storage</abbr></a></dt>
|
|||
|
</dl>
|
|||
|
|
|||
|
<h3 id="interfaces_class_traits">
|
|||
|
Interfaces, Classes and Traits
|
|||
|
<a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h3>
|
|||
|
|
|||
|
<dl class="phpdocumentor-table-of-contents">
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Taproot-IndieAuth-IndieAuthException.html"><abbr title="\Taproot\IndieAuth\IndieAuthException">IndieAuthException</abbr></a></dt>
|
|||
|
<dd></dd>
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Taproot-IndieAuth-Server.html"><abbr title="\Taproot\IndieAuth\Server">Server</abbr></a></dt>
|
|||
|
<dd>IndieAuth Server</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 -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_generateRandomString">generateRandomString()</a>
|
|||
|
<span>
|
|||
|
: mixed </span>
|
|||
|
</dt>
|
|||
|
<dd></dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_generateRandomPrintableAsciiString">generateRandomPrintableAsciiString()</a>
|
|||
|
<span>
|
|||
|
: mixed </span>
|
|||
|
</dt>
|
|||
|
<dd></dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_generatePKCECodeChallenge">generatePKCECodeChallenge()</a>
|
|||
|
<span>
|
|||
|
: mixed </span>
|
|||
|
</dt>
|
|||
|
<dd></dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_base64_urlencode">base64_urlencode()</a>
|
|||
|
<span>
|
|||
|
: mixed </span>
|
|||
|
</dt>
|
|||
|
<dd></dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_hashAuthorizationRequestParameters">hashAuthorizationRequestParameters()</a>
|
|||
|
<span>
|
|||
|
: string|null </span>
|
|||
|
</dt>
|
|||
|
<dd></dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isIndieAuthAuthorizationCodeRedeemingRequest">isIndieAuthAuthorizationCodeRedeemingRequest()</a>
|
|||
|
<span>
|
|||
|
: mixed </span>
|
|||
|
</dt>
|
|||
|
<dd></dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isIndieAuthAuthorizationRequest">isIndieAuthAuthorizationRequest()</a>
|
|||
|
<span>
|
|||
|
: mixed </span>
|
|||
|
</dt>
|
|||
|
<dd></dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isAuthorizationApprovalRequest">isAuthorizationApprovalRequest()</a>
|
|||
|
<span>
|
|||
|
: mixed </span>
|
|||
|
</dt>
|
|||
|
<dd></dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_buildQueryString">buildQueryString()</a>
|
|||
|
<span>
|
|||
|
: mixed </span>
|
|||
|
</dt>
|
|||
|
<dd></dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_urlComponentsMatch">urlComponentsMatch()</a>
|
|||
|
<span>
|
|||
|
: bool </span>
|
|||
|
</dt>
|
|||
|
<dd></dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_appendQueryParams">appendQueryParams()</a>
|
|||
|
<span>
|
|||
|
: mixed </span>
|
|||
|
</dt>
|
|||
|
<dd>Append Query Parameters</dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_trySetLogger">trySetLogger()</a>
|
|||
|
<span>
|
|||
|
: mixed </span>
|
|||
|
</dt>
|
|||
|
<dd>Try setLogger</dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_renderTemplate">renderTemplate()</a>
|
|||
|
<span>
|
|||
|
: mixed </span>
|
|||
|
</dt>
|
|||
|
<dd></dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isClientIdentifier">isClientIdentifier()</a>
|
|||
|
<span>
|
|||
|
: bool </span>
|
|||
|
</dt>
|
|||
|
<dd>Check if a provided string matches the IndieAuth criteria for a Client Identifier.</dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isProfileUrl">isProfileUrl()</a>
|
|||
|
<span>
|
|||
|
: bool </span>
|
|||
|
</dt>
|
|||
|
<dd>Check if a provided string matches the IndieAuth criteria for a User Profile URL.</dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isValidState">isValidState()</a>
|
|||
|
<span>
|
|||
|
: bool </span>
|
|||
|
</dt>
|
|||
|
<dd>OAuth 2.0 limits what values are valid for state.</dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isValidCodeChallenge">isValidCodeChallenge()</a>
|
|||
|
<span>
|
|||
|
: bool </span>
|
|||
|
</dt>
|
|||
|
<dd>IndieAuth requires PKCE. This implementation supports only S256 for hashing.</dd>
|
|||
|
|
|||
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isValidScope">isValidScope()</a>
|
|||
|
<span>
|
|||
|
: bool </span>
|
|||
|
</dt>
|
|||
|
<dd>OAuth 2.0 limits what values are valid for scope.</dd>
|
|||
|
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
<section class="phpdocumentor-functions">
|
|||
|
<h3 class="phpdocumentor-elements__header" id="functions">
|
|||
|
Functions
|
|||
|
<a href="namespaces/taproot-indieauth.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h3>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_generateRandomString">
|
|||
|
generateRandomString()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_generateRandomString" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.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"></span>
|
|||
|
<span class="phpdocumentor-signature__name">generateRandomString</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$numBytes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$numBytes</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_generateRandomPrintableAsciiString">
|
|||
|
generateRandomPrintableAsciiString()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_generateRandomPrintableAsciiString" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">28</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">generateRandomPrintableAsciiString</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$length</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$length</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_generatePKCECodeChallenge">
|
|||
|
generatePKCECodeChallenge()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_generatePKCECodeChallenge" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">37</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">generatePKCECodeChallenge</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$plaintext</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$plaintext</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_base64_urlencode">
|
|||
|
base64_urlencode()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_base64_urlencode" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">41</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">base64_urlencode</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$string</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$string</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_hashAuthorizationRequestParameters">
|
|||
|
hashAuthorizationRequestParameters()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_hashAuthorizationRequestParameters" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">45</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">hashAuthorizationRequestParameters</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\ServerRequestInterface">ServerRequestInterface</abbr> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$secret</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$algo</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|null </span><span class="phpdocumentor-signature__argument__name">$hashedParameters</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</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">$request</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\ServerRequestInterface">ServerRequestInterface</abbr></span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
<dt class="phpdocumentor-argument-list__entry">
|
|||
|
<span class="phpdocumentor-signature__argument__name">$secret</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
<dt class="phpdocumentor-argument-list__entry">
|
|||
|
<span class="phpdocumentor-signature__argument__name">$algo</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
|
|||
|
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
<dt class="phpdocumentor-argument-list__entry">
|
|||
|
<span class="phpdocumentor-signature__argument__name">$hashedParameters</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|null</span>
|
|||
|
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_isIndieAuthAuthorizationCodeRedeemingRequest">
|
|||
|
isIndieAuthAuthorizationCodeRedeemingRequest()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isIndieAuthAuthorizationCodeRedeemingRequest" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">60</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">isIndieAuthAuthorizationCodeRedeemingRequest</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\ServerRequestInterface">ServerRequestInterface</abbr> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$request</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\ServerRequestInterface">ServerRequestInterface</abbr></span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_isIndieAuthAuthorizationRequest">
|
|||
|
isIndieAuthAuthorizationRequest()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isIndieAuthAuthorizationRequest" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">66</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">isIndieAuthAuthorizationRequest</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\ServerRequestInterface">ServerRequestInterface</abbr> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$permittedMethods</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">['get']</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$request</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\ServerRequestInterface">ServerRequestInterface</abbr></span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
<dt class="phpdocumentor-argument-list__entry">
|
|||
|
<span class="phpdocumentor-signature__argument__name">$permittedMethods</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|||
|
= <span class="phpdocumentor-signature__argument__default-value">['get']</span> </dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_isAuthorizationApprovalRequest">
|
|||
|
isAuthorizationApprovalRequest()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isAuthorizationApprovalRequest" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">72</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">isAuthorizationApprovalRequest</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\ServerRequestInterface">ServerRequestInterface</abbr> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$request</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Http\Message\ServerRequestInterface">ServerRequestInterface</abbr></span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_buildQueryString">
|
|||
|
buildQueryString()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_buildQueryString" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">78</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">buildQueryString</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$parameters</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$parameters</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_urlComponentsMatch">
|
|||
|
urlComponentsMatch()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_urlComponentsMatch" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">86</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">urlComponentsMatch</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$url1</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$url2</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|null </span><span class="phpdocumentor-signature__argument__name">$components</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</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">$url1</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
<dt class="phpdocumentor-argument-list__entry">
|
|||
|
<span class="phpdocumentor-signature__argument__name">$url2</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
<dt class="phpdocumentor-argument-list__entry">
|
|||
|
<span class="phpdocumentor-signature__argument__name">$components</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|null</span>
|
|||
|
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_appendQueryParams">
|
|||
|
appendQueryParams()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_appendQueryParams" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">110</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
<p class="phpdocumentor-summary">Append Query Parameters</p>
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">appendQueryParams</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$uri</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$queryParams</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|||
|
|
|||
|
<section class="phpdocumentor-description"><p>Converts <code class="prettyprint">$queryParams</code> into a query string, then checks <code class="prettyprint">$uri</code> for an
|
|||
|
existing query string. Then appends the newly generated query string
|
|||
|
with either ? or & as appropriate.</p>
|
|||
|
</section>
|
|||
|
|
|||
|
<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">$uri</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
<dt class="phpdocumentor-argument-list__entry">
|
|||
|
<span class="phpdocumentor-signature__argument__name">$queryParams</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_trySetLogger">
|
|||
|
trySetLogger()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_trySetLogger" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">127</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
<p class="phpdocumentor-summary">Try setLogger</p>
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">trySetLogger</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$target</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Log\LoggerInterface">LoggerInterface</abbr> </span><span class="phpdocumentor-signature__argument__name">$logger</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|||
|
|
|||
|
<section class="phpdocumentor-description"><p>If <code class="prettyprint">$target</code> implements <code class="prettyprint">LoggerAwareInterface</code>, set it’s logger
|
|||
|
to <code class="prettyprint">$logger</code>. Returns <code class="prettyprint">$target</code>.</p>
|
|||
|
</section>
|
|||
|
|
|||
|
<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">$target</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
<dt class="phpdocumentor-argument-list__entry">
|
|||
|
<span class="phpdocumentor-signature__argument__name">$logger</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Psr\Log\LoggerInterface">LoggerInterface</abbr></span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_renderTemplate">
|
|||
|
renderTemplate()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_renderTemplate" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">134</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">renderTemplate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$template</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$context</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$template</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
<dt class="phpdocumentor-argument-list__entry">
|
|||
|
<span class="phpdocumentor-signature__argument__name">$context</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|||
|
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_isClientIdentifier">
|
|||
|
isClientIdentifier()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isClientIdentifier" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">159</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
<p class="phpdocumentor-summary">Check if a provided string matches the IndieAuth criteria for a Client Identifier.</p>
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">isClientIdentifier</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$client_id</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|||
|
|
|||
|
<section class="phpdocumentor-description"></section>
|
|||
|
|
|||
|
<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">$client_id</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
<section class="phpdocumentor-description"><p>The client ID provided by the OAuth Client</p>
|
|||
|
</section>
|
|||
|
|
|||
|
</dd>
|
|||
|
</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">see</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-tag-list__definition">
|
|||
|
<span class="phpdocumentor-tag-link"><a href="https://indieauth.spec.indieweb.org/#client-identifier"><abbr title="https://indieauth.spec.indieweb.org/#client-identifier">https://indieauth.spec.indieweb.org/#client-identifier</abbr></a></span>
|
|||
|
|
|||
|
<section class="phpdocumentor-description"></section>
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_isProfileUrl">
|
|||
|
isProfileUrl()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isProfileUrl" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">183</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
<p class="phpdocumentor-summary">Check if a provided string matches the IndieAuth criteria for a User Profile URL.</p>
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">isProfileUrl</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$profile_url</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|||
|
|
|||
|
<section class="phpdocumentor-description"></section>
|
|||
|
|
|||
|
<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">$profile_url</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
<section class="phpdocumentor-description"><p>The profile URL provided by the IndieAuth Client as me</p>
|
|||
|
</section>
|
|||
|
|
|||
|
</dd>
|
|||
|
</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">see</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-tag-list__definition">
|
|||
|
<span class="phpdocumentor-tag-link"><a href="https://indieauth.spec.indieweb.org/#user-profile-url"><abbr title="https://indieauth.spec.indieweb.org/#user-profile-url">https://indieauth.spec.indieweb.org/#user-profile-url</abbr></a></span>
|
|||
|
|
|||
|
<section class="phpdocumentor-description"></section>
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_isValidState">
|
|||
|
isValidState()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isValidState" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">202</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
<p class="phpdocumentor-summary">OAuth 2.0 limits what values are valid for state.</p>
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">isValidState</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$state</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|||
|
|
|||
|
<section class="phpdocumentor-description"><p>We check this first, because if valid, we want to send it along with other errors.</p>
|
|||
|
</section>
|
|||
|
|
|||
|
<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">$state</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</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">see</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-tag-list__definition">
|
|||
|
<span class="phpdocumentor-tag-link"><a href="https://tools.ietf.org/html/rfc6749#appendix-A.5"><abbr title="https://tools.ietf.org/html/rfc6749#appendix-A.5">https://tools.ietf.org/html/rfc6749#appendix-A.5</abbr></a></span>
|
|||
|
|
|||
|
<section class="phpdocumentor-description"></section>
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_isValidCodeChallenge">
|
|||
|
isValidCodeChallenge()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isValidCodeChallenge" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">211</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
<p class="phpdocumentor-summary">IndieAuth requires PKCE. This implementation supports only S256 for hashing.</p>
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">isValidCodeChallenge</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$challenge</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|||
|
|
|||
|
<section class="phpdocumentor-description"></section>
|
|||
|
|
|||
|
<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">$challenge</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</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">see</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-tag-list__definition">
|
|||
|
<span class="phpdocumentor-tag-link"><a href="https://indieauth.spec.indieweb.org/#authorization-request"><abbr title="https://indieauth.spec.indieweb.org/#authorization-request">https://indieauth.spec.indieweb.org/#authorization-request</abbr></a></span>
|
|||
|
|
|||
|
<section class="phpdocumentor-description"></section>
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
</article>
|
|||
|
<article class="phpdocumentor-element -function - ">
|
|||
|
<h4 class="phpdocumentor-element__name" id="function_isValidScope">
|
|||
|
isValidScope()
|
|||
|
<a href="namespaces/taproot-indieauth.html#function_isValidScope" class="headerlink"><i class="fas fa-link"></i></a>
|
|||
|
</h4>
|
|||
|
<aside class="phpdocumentor-element-found-in">
|
|||
|
<abbr class="phpdocumentor-element-found-in__file" title="src/functions.php"><a href="files/src-functions.html"><abbr title="src/functions.php">functions.php</abbr></a></abbr>
|
|||
|
:
|
|||
|
<span class="phpdocumentor-element-found-in__line">219</span>
|
|||
|
</aside>
|
|||
|
|
|||
|
<p class="phpdocumentor-summary">OAuth 2.0 limits what values are valid for scope.</p>
|
|||
|
|
|||
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|||
|
<span class="phpdocumentor-signature__visibility"></span>
|
|||
|
<span class="phpdocumentor-signature__name">isValidScope</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$scope</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|||
|
|
|||
|
<section class="phpdocumentor-description"></section>
|
|||
|
|
|||
|
<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">$scope</span>
|
|||
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-argument-list__definition">
|
|||
|
|
|||
|
</dd>
|
|||
|
</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">see</span>
|
|||
|
</dt>
|
|||
|
<dd class="phpdocumentor-tag-list__definition">
|
|||
|
<span class="phpdocumentor-tag-link"><a href="https://tools.ietf.org/html/rfc6749#section-3.3"><abbr title="https://tools.ietf.org/html/rfc6749#section-3.3">https://tools.ietf.org/html/rfc6749#section-3.3</abbr></a></span>
|
|||
|
|
|||
|
<section class="phpdocumentor-description"></section>
|
|||
|
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
|
|||
|
|
|||
|
</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="namespaces/taproot-indieauth.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|||
|
|
|||
|
</main>
|
|||
|
|
|||
|
<script>
|
|||
|
cssVars({});
|
|||
|
</script>
|
|||
|
</body>
|
|||
|
</html>
|