PHPWord/classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html

1010 lines
50 KiB
HTML
Raw Normal View History

<!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>
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/phpoffice.html"><abbr title="\PhpOffice">PhpOffice</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/phpoffice-phpword.html"><abbr title="\PhpOffice\PhpWord">PhpWord</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/phpoffice.html">PhpOffice</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword.html">PhpWord</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword-shared.html">Shared</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword-shared-microsoft.html">Microsoft</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
PasswordEncoder
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">23</span>
</aside>
<p class="phpdocumentor-summary">Password encoder for microsoft office applications</p>
<section class="phpdocumentor-description"></section>
<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 -constant -public">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_HMAC">ALGORITHM_HMAC</a>
<span>
&nbsp;= &#039;HMAC&#039; </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_MAC">ALGORITHM_MAC</a>
<span>
&nbsp;= &#039;MAC&#039; </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_MD2">ALGORITHM_MD2</a>
<span>
&nbsp;= &#039;MD2&#039; </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_MD4">ALGORITHM_MD4</a>
<span>
&nbsp;= &#039;MD4&#039; </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_MD5">ALGORITHM_MD5</a>
<span>
&nbsp;= &#039;MD5&#039; </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_RIPEMD">ALGORITHM_RIPEMD</a>
<span>
&nbsp;= &#039;RIPEMD&#039; </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_RIPEMD_160">ALGORITHM_RIPEMD_160</a>
<span>
&nbsp;= &#039;RIPEMD-160&#039; </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_SHA_1">ALGORITHM_SHA_1</a>
<span>
&nbsp;= &#039;SHA-1&#039; </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_SHA_256">ALGORITHM_SHA_256</a>
<span>
&nbsp;= &#039;SHA-256&#039; </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_SHA_384">ALGORITHM_SHA_384</a>
<span>
&nbsp;= &#039;SHA-384&#039; </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_SHA_512">ALGORITHM_SHA_512</a>
<span>
&nbsp;= &#039;SHA-512&#039; </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#property_algorithmMapping">$algorithmMapping</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Mapping between algorithm name and algorithm ID</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#property_encryptionMatrix">$encryptionMatrix</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#property_initialCodeArray">$initialCodeArray</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#property_passwordMaxLength">$passwordMaxLength</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#method_getAlgorithmId">getAlgorithmId()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Returns the algorithm ID</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#method_hashPassword">hashPassword()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Create a hashed password that MS Word will be able to work with</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#method_buildCombinedKey">buildCombinedKey()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Build combined key from low-order word and high-order word</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#method_getAlgorithm">getAlgorithm()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get algorithm from self::$algorithmMapping</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#method_int32">int32()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Simulate behaviour of (signed) int32</dd>
</dl>
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_ALGORITHM_HMAC">
ALGORITHM_HMAC
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_HMAC" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">ALGORITHM_HMAC</span>
= <span class="phpdocumentor-signature__default-value">&#039;HMAC&#039;</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_ALGORITHM_MAC">
ALGORITHM_MAC
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_MAC" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">ALGORITHM_MAC</span>
= <span class="phpdocumentor-signature__default-value">&#039;MAC&#039;</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_ALGORITHM_MD2">
ALGORITHM_MD2
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_MD2" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">ALGORITHM_MD2</span>
= <span class="phpdocumentor-signature__default-value">&#039;MD2&#039;</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_ALGORITHM_MD4">
ALGORITHM_MD4
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_MD4" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">ALGORITHM_MD4</span>
= <span class="phpdocumentor-signature__default-value">&#039;MD4&#039;</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_ALGORITHM_MD5">
ALGORITHM_MD5
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_MD5" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">ALGORITHM_MD5</span>
= <span class="phpdocumentor-signature__default-value">&#039;MD5&#039;</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_ALGORITHM_RIPEMD">
ALGORITHM_RIPEMD
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_RIPEMD" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">ALGORITHM_RIPEMD</span>
= <span class="phpdocumentor-signature__default-value">&#039;RIPEMD&#039;</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_ALGORITHM_RIPEMD_160">
ALGORITHM_RIPEMD_160
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_RIPEMD_160" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">ALGORITHM_RIPEMD_160</span>
= <span class="phpdocumentor-signature__default-value">&#039;RIPEMD-160&#039;</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_ALGORITHM_SHA_1">
ALGORITHM_SHA_1
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_SHA_1" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">ALGORITHM_SHA_1</span>
= <span class="phpdocumentor-signature__default-value">&#039;SHA-1&#039;</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_ALGORITHM_SHA_256">
ALGORITHM_SHA_256
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_SHA_256" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">ALGORITHM_SHA_256</span>
= <span class="phpdocumentor-signature__default-value">&#039;SHA-256&#039;</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_ALGORITHM_SHA_384">
ALGORITHM_SHA_384
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_SHA_384" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">ALGORITHM_SHA_384</span>
= <span class="phpdocumentor-signature__default-value">&#039;SHA-384&#039;</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_ALGORITHM_SHA_512">
ALGORITHM_SHA_512
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#constant_ALGORITHM_SHA_512" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">ALGORITHM_SHA_512</span>
= <span class="phpdocumentor-signature__default-value">&#039;SHA-512&#039;</span>
</code>
</article>
</section>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="property_algorithmMapping">
$algorithmMapping
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#property_algorithmMapping" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
</aside>
<p class="phpdocumentor-summary">Mapping between algorithm name and algorithm ID</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$algorithmMapping</span>
= <span class="phpdocumentor-signature__default-value">array(
self::ALGORITHM_MD2 =&gt; array(1, &#039;md2&#039;),
self::ALGORITHM_MD4 =&gt; array(2, &#039;md4&#039;),
self::ALGORITHM_MD5 =&gt; array(3, &#039;md5&#039;),
self::ALGORITHM_SHA_1 =&gt; array(4, &#039;sha1&#039;),
self::ALGORITHM_MAC =&gt; array(5, &#039;&#039;),
// &#039;mac&#039; -&gt; not possible with hash()
self::ALGORITHM_RIPEMD =&gt; array(6, &#039;ripemd&#039;),
self::ALGORITHM_RIPEMD_160 =&gt; array(7, &#039;ripemd160&#039;),
self::ALGORITHM_HMAC =&gt; array(9, &#039;&#039;),
//&#039;hmac&#039; -&gt; not possible with hash()
self::ALGORITHM_SHA_256 =&gt; array(12, &#039;sha256&#039;),
self::ALGORITHM_SHA_384 =&gt; array(13, &#039;sha384&#039;),
self::ALGORITHM_SHA_512 =&gt; array(14, &#039;sha512&#039;),
)</span></code>
<section class="phpdocumentor-description"></section>
<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://msdn.microsoft.com/en-us/library/documentformat.openxml.wordprocessing.writeprotection.cryptographicalgorithmsid(v=office.14).aspx"><abbr title="https://msdn.microsoft.com/en-us/library/documentformat.openxml.wordprocessing.writeprotection.cryptographicalgorithmsid(v=office.14).aspx">https://msdn.microsoft.com/en-us/library/documentformat.openxml.wordprocessing.writeprotection.cryptographicalgorithmsid(v=office.14).aspx</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="property_encryptionMatrix">
$encryptionMatrix
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#property_encryptionMatrix" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">75</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">$encryptionMatrix</span>
= <span class="phpdocumentor-signature__default-value">array(array(0xaefc, 0x4dd9, 0x9bb2, 0x2745, 0x4e8a, 0x9d14, 0x2a09), array(0x7b61, 0xf6c2, 0xfda5, 0xeb6b, 0xc6f7, 0x9dcf, 0x2bbf), array(0x4563, 0x8ac6, 0x5ad, 0xb5a, 0x16b4, 0x2d68, 0x5ad0), array(0x375, 0x6ea, 0xdd4, 0x1ba8, 0x3750, 0x6ea0, 0xdd40), array(0xd849, 0xa0b3, 0x5147, 0xa28e, 0x553d, 0xaa7a, 0x44d5), array(0x6f45, 0xde8a, 0xad35, 0x4a4b, 0x9496, 0x390d, 0x721a), array(0xeb23, 0xc667, 0x9cef, 0x29ff, 0x53fe, 0xa7fc, 0x5fd9), array(0x47d3, 0x8fa6, 0xf6d, 0x1eda, 0x3db4, 0x7b68, 0xf6d0), array(0xb861, 0x60e3, 0xc1c6, 0x93ad, 0x377b, 0x6ef6, 0xddec), array(0x45a0, 0x8b40, 0x6a1, 0xd42, 0x1a84, 0x3508, 0x6a10), array(0xaa51, 0x4483, 0x8906, 0x22d, 0x45a, 0x8b4, 0x1168), array(0x76b4, 0xed68, 0xcaf1, 0x85c3, 0x1ba7, 0x374e, 0x6e9c), array(0x3730, 0x6e60, 0xdcc0, 0xa9a1, 0x4363, 0x86c6, 0x1dad), array(0x3331, 0x6662, 0xccc4, 0x89a9, 0x373, 0x6e6, 0xdcc), array(0x1021, 0x2042, 0x4084, 0x8108, 0x1231, 0x2462, 0x48c4))</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="property_initialCodeArray">
$initialCodeArray
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#property_initialCodeArray" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">$initialCodeArray</span>
= <span class="phpdocumentor-signature__default-value">array(0xe1f0, 0x1d0f, 0xcc9c, 0x84c0, 0x110c, 0xe10, 0xf1ce, 0x313e, 0x1872, 0xe139, 0xd40f, 0x84f9, 0x280c, 0xa96a, 0x4ec3)</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="property_passwordMaxLength">
$passwordMaxLength
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#property_passwordMaxLength" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">93</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">$passwordMaxLength</span>
= <span class="phpdocumentor-signature__default-value">15</span></code>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getAlgorithmId">
getAlgorithmId()
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#method_getAlgorithmId" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">171</span>
</aside>
<p class="phpdocumentor-summary">Returns the algorithm ID</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getAlgorithmId</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$algorithmName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</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">$algorithmName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_hashPassword">
hashPassword()
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#method_hashPassword" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Create a hashed password that MS Word will be able to work with</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">hashPassword</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$password</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$algorithmName</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">self::ALGORITHM_SHA_1</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$salt</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">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$spinCount</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">10000</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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">$password</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$algorithmName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">self::ALGORITHM_SHA_1</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$salt</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spinCount</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">10000</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></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://blogs.msdn.microsoft.com/vsod/2010/04/05/how-to-set-the-editing-restrictions-in-word-using-open-xml-sdk-2-0/"><abbr title="https://blogs.msdn.microsoft.com/vsod/2010/04/05/how-to-set-the-editing-restrictions-in-word-using-open-xml-sdk-2-0/">https://blogs.msdn.microsoft.com/vsod/2010/04/05/how-to-set-the-editing-restrictions-in-word-using-open-xml-sdk-2-0/</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_buildCombinedKey">
buildCombinedKey()
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#method_buildCombinedKey" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<p class="phpdocumentor-summary">Build combined key from low-order word and high-order word</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">buildCombinedKey</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$byteChars</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</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">$byteChars</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>byte array representation of password</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getAlgorithm">
getAlgorithm()
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#method_getAlgorithm" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">155</span>
</aside>
<p class="phpdocumentor-summary">Get algorithm from self::$algorithmMapping</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getAlgorithm</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$algorithmName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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">$algorithmName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_int32">
int32()
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#method_int32" 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/PhpWord/Shared/Microsoft/PasswordEncoder.php"><a href="files/src-phpword-shared-microsoft-passwordencoder.html"><abbr title="src/PhpWord/Shared/Microsoft/PasswordEncoder.php">PasswordEncoder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">225</span>
</aside>
<p class="phpdocumentor-summary">Simulate behaviour of (signed) int32</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">int32</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</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">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></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">codeCoverageIgnore</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
</section>
</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="classes/PhpOffice-PhpWord-Shared-Microsoft-PasswordEncoder.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>