Files
doc-en/reference/event/eventconfig/construct.xml
Ruslan Osmanov b621ab27a9 Updated Event docs (#3137)
- Added EventException class.
- Updated description of the initialize parameter of the EventDnsBase::__construct
2024-01-27 19:21:17 +00:00

77 lines
1.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="eventconfig.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EventConfig::__construct</refname>
<refpurpose>Constructs EventConfig object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<methodname>EventConfig::__construct</methodname>
<void />
</methodsynopsis>
<para>
Constructs EventConfig object which could be passed to
<methodname>EventBase::__construct</methodname>
constructor.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>
<function>EventConfig::__construct</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Avoiding "select" method
$cfg = new EventConfig();
if ($cfg->avoidMethod("select")) {
echo "'select' method avoided\n";
}
// Create event_base associated with the config
$base = new EventBase($cfg);
/* Now $base is configured to avoid select backend(method) */
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member>
<methodname>EventBase::__construct</methodname>
</member>
</simplelist>
</refsect1>
</refentry>
<!-- 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
-->