File: C:/Ruby27-x64/share/doc/ruby/html/URI/LDAP.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class URI::LDAP - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="Generic.html">URI::Generic</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-build">::build</a>
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-attributes">#attributes</a>
<li ><a href="#method-i-attributes-3D">#attributes=</a>
<li ><a href="#method-i-build_path_query">#build_path_query</a>
<li ><a href="#method-i-dn">#dn</a>
<li ><a href="#method-i-dn-3D">#dn=</a>
<li ><a href="#method-i-extensions">#extensions</a>
<li ><a href="#method-i-extensions-3D">#extensions=</a>
<li ><a href="#method-i-filter">#filter</a>
<li ><a href="#method-i-filter-3D">#filter=</a>
<li ><a href="#method-i-hierarchical-3F">#hierarchical?</a>
<li ><a href="#method-i-parse_dn">#parse_dn</a>
<li ><a href="#method-i-parse_query">#parse_query</a>
<li ><a href="#method-i-scope">#scope</a>
<li ><a href="#method-i-scope-3D">#scope=</a>
<li ><a href="#method-i-set_attributes">#set_attributes</a>
<li ><a href="#method-i-set_dn">#set_dn</a>
<li ><a href="#method-i-set_extensions">#set_extensions</a>
<li ><a href="#method-i-set_filter">#set_filter</a>
<li ><a href="#method-i-set_scope">#set_scope</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-URI::LDAP">
<h1 id="class-URI::LDAP" class="class">
class URI::LDAP
</h1>
<section class="description">
<p><a href="LDAP.html"><code>LDAP</code></a> <a href="../URI.html"><code>URI</code></a> SCHEMA (described in RFC2255).</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="COMPONENT">COMPONENT
<dd><p>An <a href="../Array.html"><code>Array</code></a> of the available components for <a href="LDAP.html"><code>URI::LDAP</code></a>.</p>
<dt id="DEFAULT_PORT">DEFAULT_PORT
<dd><p>A Default port of 389 for <a href="LDAP.html"><code>URI::LDAP</code></a>.</p>
<dt id="SCOPE">SCOPE
<dd><p>Scopes available for the starting point.</p>
<ul><li>
<p>SCOPE_BASE - the Base DN</p>
</li><li>
<p>SCOPE_ONE - one level under the Base DN, not including the base DN and not including any entries under this</p>
</li><li>
<p>SCOPE_SUB - subtrees, all entries at all levels</p>
</li></ul>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-build" class="method-detail ">
<div class="method-heading">
<span class="method-name">build</span><span
class="method-args">(args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<h2 id="method-c-build-label-Description">Description<span><a href="#method-c-build-label-Description">¶</a> <a href="#top">↑</a></span></h2>
<p>Creates a new <a href="LDAP.html"><code>URI::LDAP</code></a> object from components, with syntax checking.</p>
<p>The components accepted are host, port, dn, attributes, scope, filter, and extensions.</p>
<p>The components should be provided either as an <a href="../Array.html"><code>Array</code></a>, or as a <a href="../Hash.html"><code>Hash</code></a> with keys formed by preceding the component names with a colon.</p>
<p>If an <a href="../Array.html"><code>Array</code></a> is used, the components must be passed in the order <code>[host, port, dn, attributes, scope, filter, extensions]</code>.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">LDAP</span>.<span class="ruby-identifier">build</span>({<span class="ruby-value">:host</span> <span class="ruby-operator">=></span> <span class="ruby-string">'ldap.example.com'</span>,
<span class="ruby-value">:dn</span> <span class="ruby-operator">=></span> <span class="ruby-string">'/dc=example'</span>})
<span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">LDAP</span>.<span class="ruby-identifier">build</span>([<span class="ruby-string">"ldap.example.com"</span>, <span class="ruby-keyword">nil</span>,
<span class="ruby-string">"/dc=example;dc=com"</span>, <span class="ruby-string">"query"</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>])
</pre>
<div class="method-calls-super">
Calls superclass method
<a href="Generic.html#method-c-build"><code>URI::Generic::build</code></a>
</div>
<div class="method-source-code" id="build-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">build</span>(<span class="ruby-identifier">args</span>)
<span class="ruby-identifier">tmp</span> = <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-identifier">make_components_hash</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">args</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">tmp</span>[<span class="ruby-value">:dn</span>]
<span class="ruby-identifier">tmp</span>[<span class="ruby-value">:path</span>] = <span class="ruby-identifier">tmp</span>[<span class="ruby-value">:dn</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">query</span> = []
[<span class="ruby-value">:extensions</span>, <span class="ruby-value">:filter</span>, <span class="ruby-value">:scope</span>, <span class="ruby-value">:attributes</span>].<span class="ruby-identifier">collect</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">tmp</span>[<span class="ruby-identifier">x</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">query</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">query</span>.<span class="ruby-identifier">unshift</span>(<span class="ruby-identifier">tmp</span>[<span class="ruby-identifier">x</span>])
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">tmp</span>[<span class="ruby-value">:query</span>] = <span class="ruby-identifier">query</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'?'</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">super</span>(<span class="ruby-identifier">tmp</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(*arg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<h2 id="method-c-new-label-Description">Description<span><a href="#method-c-new-label-Description">¶</a> <a href="#top">↑</a></span></h2>
<p>Creates a new <a href="LDAP.html"><code>URI::LDAP</code></a> object from generic <a href="../URI.html"><code>URI</code></a> components as per RFC 2396. No LDAP-specific syntax checking is performed.</p>
<p>Arguments are <code>scheme</code>, <code>userinfo</code>, <code>host</code>, <code>port</code>, <code>registry</code>, <code>path</code>, <code>opaque</code>, <code>query</code>, and <code>fragment</code>, in that order.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">LDAP</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"ldap"</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-string">"ldap.example.com"</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>,
<span class="ruby-string">"/dc=example;dc=com"</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-string">"query"</span>, <span class="ruby-keyword">nil</span>)
</pre>
<p>See also <a href="Generic.html#method-c-new"><code>URI::Generic.new</code></a>.</p>
<div class="method-calls-super">
Calls superclass method
<a href="Generic.html#method-c-new"><code>URI::Generic::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 109</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">super</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@fragment</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidURIError</span>, <span class="ruby-string">'bad LDAP URL'</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">parse_dn</span>
<span class="ruby-identifier">parse_query</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-attributes" class="method-detail ">
<div class="method-heading">
<span class="method-name">attributes</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns attributes.</p>
<div class="method-source-code" id="attributes-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 179</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">attributes</span>
<span class="ruby-ivar">@attributes</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-attributes-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">attributes=</span><span
class="method-args">(val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Setter for attributes <code>val</code>.</p>
<div class="method-source-code" id="attributes-3D-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 192</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">attributes=</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-identifier">set_attributes</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-dn" class="method-detail ">
<div class="method-heading">
<span class="method-name">dn</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns dn.</p>
<div class="method-source-code" id="dn-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 160</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">dn</span>
<span class="ruby-ivar">@dn</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-dn-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">dn=</span><span
class="method-args">(val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Setter for dn <code>val</code>.</p>
<div class="method-source-code" id="dn-3D-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 173</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">dn=</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-identifier">set_dn</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-extensions" class="method-detail ">
<div class="method-heading">
<span class="method-name">extensions</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns extensions.</p>
<div class="method-source-code" id="extensions-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 236</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">extensions</span>
<span class="ruby-ivar">@extensions</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-extensions-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">extensions=</span><span
class="method-args">(val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Setter for extensions <code>val</code>.</p>
<div class="method-source-code" id="extensions-3D-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 249</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">extensions=</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-identifier">set_extensions</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-filter" class="method-detail ">
<div class="method-heading">
<span class="method-name">filter</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns filter.</p>
<div class="method-source-code" id="filter-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 217</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">filter</span>
<span class="ruby-ivar">@filter</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-filter-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">filter=</span><span
class="method-args">(val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Setter for filter <code>val</code>.</p>
<div class="method-source-code" id="filter-3D-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 230</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">filter=</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-identifier">set_filter</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-hierarchical-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">hierarchical?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Checks if <a href="../URI.html"><code>URI</code></a> has a path. For <a href="LDAP.html"><code>URI::LDAP</code></a> this will return <code>false</code>.</p>
<div class="method-source-code" id="hierarchical-3F-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 256</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">hierarchical?</span>
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-scope" class="method-detail ">
<div class="method-heading">
<span class="method-name">scope</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns scope.</p>
<div class="method-source-code" id="scope-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 198</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">scope</span>
<span class="ruby-ivar">@scope</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-scope-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">scope=</span><span
class="method-args">(val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Setter for scope <code>val</code>.</p>
<div class="method-source-code" id="scope-3D-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 211</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">scope=</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-identifier">set_scope</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Protected Instance Methods</h3>
</header>
<div id="method-i-set_attributes" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_attributes</span><span
class="method-args">(val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Private setter for attributes <code>val</code>.</p>
<div class="method-source-code" id="set_attributes-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 184</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_attributes</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-ivar">@attributes</span> = <span class="ruby-identifier">val</span>
<span class="ruby-identifier">build_path_query</span>
<span class="ruby-ivar">@attributes</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_dn" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_dn</span><span
class="method-args">(val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Private setter for dn <code>val</code>.</p>
<div class="method-source-code" id="set_dn-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 165</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_dn</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-ivar">@dn</span> = <span class="ruby-identifier">val</span>
<span class="ruby-identifier">build_path_query</span>
<span class="ruby-ivar">@dn</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_extensions" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_extensions</span><span
class="method-args">(val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Private setter for extensions <code>val</code>.</p>
<div class="method-source-code" id="set_extensions-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 241</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_extensions</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-ivar">@extensions</span> = <span class="ruby-identifier">val</span>
<span class="ruby-identifier">build_path_query</span>
<span class="ruby-ivar">@extensions</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_filter" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_filter</span><span
class="method-args">(val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Private setter for filter <code>val</code>.</p>
<div class="method-source-code" id="set_filter-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 222</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_filter</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-ivar">@filter</span> = <span class="ruby-identifier">val</span>
<span class="ruby-identifier">build_path_query</span>
<span class="ruby-ivar">@filter</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_scope" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_scope</span><span
class="method-args">(val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Private setter for scope <code>val</code>.</p>
<div class="method-source-code" id="set_scope-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 203</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_scope</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-ivar">@scope</span> = <span class="ruby-identifier">val</span>
<span class="ruby-identifier">build_path_query</span>
<span class="ruby-ivar">@scope</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-build_path_query" class="method-detail ">
<div class="method-heading">
<span class="method-name">build_path_query</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Private method to assemble <code>query</code> from <code>attributes</code>, <code>scope</code>, <code>filter</code>, and <code>extensions</code>.</p>
<div class="method-source-code" id="build_path_query-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 147</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_path_query</span>
<span class="ruby-ivar">@path</span> = <span class="ruby-string">'/'</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@dn</span>
<span class="ruby-identifier">query</span> = []
[<span class="ruby-ivar">@extensions</span>, <span class="ruby-ivar">@filter</span>, <span class="ruby-ivar">@scope</span>, <span class="ruby-ivar">@attributes</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">x</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">query</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">query</span>.<span class="ruby-identifier">unshift</span>(<span class="ruby-identifier">x</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@query</span> = <span class="ruby-identifier">query</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'?'</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-parse_dn" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse_dn</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Private method to cleanup <code>dn</code> from using the <code>path</code> component attribute.</p>
<div class="method-source-code" id="parse_dn-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 121</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse_dn</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidURIError</span>, <span class="ruby-string">'bad LDAP URL'</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@path</span>
<span class="ruby-ivar">@dn</span> = <span class="ruby-ivar">@path</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-parse_query" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse_query</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Private method to cleanup <code>attributes</code>, <code>scope</code>, <code>filter</code>, and <code>extensions</code> from using the <code>query</code> component attribute.</p>
<div class="method-source-code" id="parse_query-source">
<pre><span class="ruby-comment"># File lib/uri/ldap.rb, line 129</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse_query</span>
<span class="ruby-ivar">@attributes</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@scope</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@filter</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@extensions</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@query</span>
<span class="ruby-identifier">attrs</span>, <span class="ruby-identifier">scope</span>, <span class="ruby-identifier">filter</span>, <span class="ruby-identifier">extensions</span> = <span class="ruby-ivar">@query</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'?'</span>)
<span class="ruby-ivar">@attributes</span> = <span class="ruby-identifier">attrs</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">attrs</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">attrs</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="ruby-ivar">@scope</span> = <span class="ruby-identifier">scope</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">scope</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">scope</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="ruby-ivar">@filter</span> = <span class="ruby-identifier">filter</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">filter</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">filter</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="ruby-ivar">@extensions</span> = <span class="ruby-identifier">extensions</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">extensions</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">extensions</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>