1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
|
<?xml version="1.0" encoding="utf-8"?>
<reference xml:id="class.sensitiveparametervalue" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The SensitiveParameterValue class</title>
<titleabbrev>SensitiveParameterValue</titleabbrev>
<partintro>
<!-- {{{ SensitiveParameterValue intro -->
<section xml:id="sensitiveparametervalue.intro">
&reftitle.intro;
<para>
The <classname>SensitiveParameterValue</classname> class allows wrapping sensitive
values to protect them against accidental exposure.
</para>
<para>
Values of parameters having the <classname>SensitiveParameter</classname> attribute
will automatically be wrapped inside of a <classname>SensitiveParameterValue</classname>
object within stack traces.
</para>
</section>
<!-- }}} -->
<section xml:id="sensitiveparametervalue.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis class="class">
<ooclass>
<modifier>final</modifier>
<classname>SensitiveParameterValue</classname>
</ooclass>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>private</modifier>
<modifier>readonly</modifier>
<type>mixed</type>
<varname linkend="sensitiveparametervalue.props.value">value</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.sensitiveparametervalue')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='SensitiveParameterValue'])">
<xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.sensitiveparametervalue')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='SensitiveParameterValue'])">
<xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ Random\Randomizer properties -->
<section xml:id="sensitiveparametervalue.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="sensitiveparametervalue.props.value">
<term><varname>value</varname></term>
<listitem>
<para>
The sensitive value to be protected against accidental exposure.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&language.predefined.sensitiveparametervalue.construct;
&language.predefined.sensitiveparametervalue.debuginfo;
&language.predefined.sensitiveparametervalue.getvalue;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|