arachnid/docs/Arachnid/Document/HTML.html

560 lines
17 KiB
HTML
Raw Normal View History

2019-06-27 03:25:07 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../../";
</script>
<meta id="repository-name" content="github.com/watzon/arachnid">
<title>Arachnid::Document::HTML - github.com/watzon/arachnid</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid" data-name="arachnid">
<a href="../../Arachnid.html">Arachnid</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent" data-name="arachnid::agent">
<a href="../../Arachnid/Agent.html">Agent</a>
<ul>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions" data-name="arachnid::agent::actions">
<a href="../../Arachnid/Agent/Actions.html">Actions</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Action" data-name="arachnid::agent::actions::action">
<a href="../../Arachnid/Agent/Actions/Action.html">Action</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/Paused" data-name="arachnid::agent::actions::paused">
<a href="../../Arachnid/Agent/Actions/Paused.html">Paused</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/RuntimeError" data-name="arachnid::agent::actions::runtimeerror">
<a href="../../Arachnid/Agent/Actions/RuntimeError.html">RuntimeError</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipLink" data-name="arachnid::agent::actions::skiplink">
<a href="../../Arachnid/Agent/Actions/SkipLink.html">SkipLink</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Actions/SkipResource" data-name="arachnid::agent::actions::skipresource">
<a href="../../Arachnid/Agent/Actions/SkipResource.html">SkipResource</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Agent/Queue" data-name="arachnid::agent::queue">
<a href="../../Arachnid/Agent/Queue.html">Queue</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthCredential" data-name="arachnid::authcredential">
<a href="../../Arachnid/AuthCredential.html">AuthCredential</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/AuthStore" data-name="arachnid::authstore">
<a href="../../Arachnid/AuthStore.html">AuthStore</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/CookieJar" data-name="arachnid::cookiejar">
<a href="../../Arachnid/CookieJar.html">CookieJar</a>
</li>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Document" data-name="arachnid::document">
<a href="../../Arachnid/Document.html">Document</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/arachnid/Arachnid/Document/HTML" data-name="arachnid::document::html">
<a href="../../Arachnid/Document/HTML.html">HTML</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Document/HTML/Tag" data-name="arachnid::document::html::tag">
<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="github.com/watzon/arachnid/Arachnid/Resource" data-name="arachnid::resource">
<a href="../../Arachnid/Resource.html">Resource</a>
<ul>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/ContentTypes" data-name="arachnid::resource::contenttypes">
<a href="../../Arachnid/Resource/ContentTypes.html">ContentTypes</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/Cookies" data-name="arachnid::resource::cookies">
<a href="../../Arachnid/Resource/Cookies.html">Cookies</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/HTML" data-name="arachnid::resource::html">
<a href="../../Arachnid/Resource/HTML.html">HTML</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Resource/StatusCodes" data-name="arachnid::resource::statuscodes">
<a href="../../Arachnid/Resource/StatusCodes.html">StatusCodes</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/Rules" data-name="arachnid::rules(t)">
<a href="../../Arachnid/Rules.html">Rules</a>
</li>
<li class=" " data-id="github.com/watzon/arachnid/Arachnid/SessionCache" data-name="arachnid::sessioncache">
<a href="../../Arachnid/SessionCache.html">SessionCache</a>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/arachnid/URI" data-name="uri">
<a href="../../URI.html">URI</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">struct</span> Arachnid::Document::HTML
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../../Arachnid/Document/HTML.html">Arachnid::Document::HTML</a></li><li class="superclass">Struct</li><li class="superclass">Value</li><li class="superclass">Object</li></ul>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L5" target="_blank">
arachnid/document/html.cr
</a>
<br/>
<h2>Constructors</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#new%28content%3AString%29-class-method" class="signature"><strong>.new</strong>(content : String)</a>
</li>
</ul>
<h2>Class Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#css_query_to_xpath%28query%3AString%29%3AString-class-method" class="signature"><strong>.css_query_to_xpath</strong>(query : String) : String</a>
<div class="summary"><p>Transform the css query into an xpath query</p></div>
</li>
<li class="entry-summary">
<a href="#parse%28content%3AString%29-class-method" class="signature"><strong>.parse</strong>(content : String)</a>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#at_css%28query%3AString%29-instance-method" class="signature"><strong>#at_css</strong>(query : String)</a>
<div class="summary"><p>Find first node corresponding to the css query and return <code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> if found or <code>nil</code> if not found</p></div>
</li>
<li class="entry-summary">
<a href="#at_id%28id_name%3AString%29%3ATag%3F-instance-method" class="signature"><strong>#at_id</strong>(id_name : String) : Tag?</a>
<div class="summary"><p>Find a node by its id and return a <code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> found or <code>nil</code> if not found</p></div>
</li>
<li class="entry-summary">
<a href="#at_tag%28tag_name%3AString%29%3ATag%3F-instance-method" class="signature"><strong>#at_tag</strong>(tag_name : String) : Tag?</a>
<div class="summary"><p>Find first tag by tag name and return <code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> if found or <code>nil</code> if not found</p></div>
</li>
<li class="entry-summary">
<a href="#css%28query%3AString%2C%26block%29%3AArray%28Tag%29-instance-method" class="signature"><strong>#css</strong>(query : String, &block) : Array(Tag)</a>
<div class="summary"><p>Find all nodes corresponding to the css query and yield <code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> found or <code>nil</code> if not found</p></div>
</li>
<li class="entry-summary">
<a href="#where_class%28class_name%3AString%2C%26block%29%3AArray%28Tag%29-instance-method" class="signature"><strong>#where_class</strong>(class_name : String, &block) : Array(Tag)</a>
<div class="summary"><p>Find all nodes by classname and yield <code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> founded</p></div>
</li>
<li class="entry-summary">
<a href="#where_tag%28tag_name%3AString%2C%26block%29%3AArray%28Tag%29-instance-method" class="signature"><strong>#where_tag</strong>(tag_name : String, &block) : Array(Tag)</a>
<div class="summary"><p>Find all nodes by tag name and yield <code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> if found</p></div>
</li>
</ul>
<h2>Macro Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#method_missing%28call%29-macro" class="signature"><strong>method_missing</strong>(call)</a>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Constructor Detail</h2>
<div class="entry-detail" id="new(content:String)-class-method">
<div class="signature">
def self.<strong>new</strong>(content : String)
<a class="method-permalink" href="#new%28content%3AString%29-class-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L18" target="_blank">View source</a>]
</div>
</div>
<h2>Class Method Detail</h2>
<div class="entry-detail" id="css_query_to_xpath(query:String):String-class-method">
<div class="signature">
def self.<strong>css_query_to_xpath</strong>(query : String) : String
<a class="method-permalink" href="#css_query_to_xpath%28query%3AString%29%3AString-class-method">#</a>
</div>
<div class="doc"><p>Transform the css query into an xpath query</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L33" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="parse(content:String)-class-method">
<div class="signature">
def self.<strong>parse</strong>(content : String)
<a class="method-permalink" href="#parse%28content%3AString%29-class-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L28" target="_blank">View source</a>]
</div>
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="at_css(query:String)-instance-method">
<div class="signature">
def <strong>at_css</strong>(query : String)
<a class="method-permalink" href="#at_css%28query%3AString%29-instance-method">#</a>
</div>
<div class="doc"><p>Find first node corresponding to the css query and return
<code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> if found or <code>nil</code> if not found</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L107" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="at_id(id_name:String):Tag?-instance-method">
<div class="signature">
def <strong>at_id</strong>(id_name : String) : <a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>?
<a class="method-permalink" href="#at_id%28id_name%3AString%29%3ATag%3F-instance-method">#</a>
</div>
<div class="doc"><p>Find a node by its id and return a
<code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> found or <code>nil</code> if not found</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L88" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="at_tag(tag_name:String):Tag?-instance-method">
<div class="signature">
def <strong>at_tag</strong>(tag_name : String) : <a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>?
<a class="method-permalink" href="#at_tag%28tag_name%3AString%29%3ATag%3F-instance-method">#</a>
</div>
<div class="doc"><p>Find first tag by tag name and return
<code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> if found or <code>nil</code> if not found</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L50" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="css(query:String,&amp;block):Array(Tag)-instance-method">
<div class="signature">
def <strong>css</strong>(query : String, &block) : Array(<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>)
<a class="method-permalink" href="#css%28query%3AString%2C%26block%29%3AArray%28Tag%29-instance-method">#</a>
</div>
<div class="doc"><p>Find all nodes corresponding to the css query and yield
<code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> found or <code>nil</code> if not found</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L96" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="where_class(class_name:String,&amp;block):Array(Tag)-instance-method">
<div class="signature">
def <strong>where_class</strong>(class_name : String, &block) : Array(<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>)
<a class="method-permalink" href="#where_class%28class_name%3AString%2C%26block%29%3AArray%28Tag%29-instance-method">#</a>
</div>
<div class="doc"><p>Find all nodes by classname and yield
<code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> founded</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L74" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="where_tag(tag_name:String,&amp;block):Array(Tag)-instance-method">
<div class="signature">
def <strong>where_tag</strong>(tag_name : String, &block) : Array(<a href="../../Arachnid/Document/HTML/Tag.html">Tag</a>)
<a class="method-permalink" href="#where_tag%28tag_name%3AString%2C%26block%29%3AArray%28Tag%29-instance-method">#</a>
</div>
<div class="doc"><p>Find all nodes by tag name and yield
<code><a href="../../Arachnid/Document/HTML/Tag.html">HTML::Tag</a></code> if found</p></div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L61" target="_blank">View source</a>]
</div>
</div>
<h2>Macro Detail</h2>
<div class="entry-detail" id="method_missing(call)-macro">
<div class="signature">
macro <strong>method_missing</strong>(call)
<a class="method-permalink" href="#method_missing%28call%29-macro">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/watzon/arachnid/blob/32bf4d89b826d76adc3c6f2cd160bfd2348ace03/src/arachnid/document/html.cr#L16" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>