<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Prismic::Fragments::DocumentLink
— Documentation by YARD 0.8.7.4
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../';
framesUrl = "../../frames.html#!Prismic/Fragments/DocumentLink.html";
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (D)</a> »
<span class='title'><span class='object_link'><a href="../../Prismic.html" title="Prismic (module)">Prismic</a></span></span> » <span class='title'><span class='object_link'><a href="../Fragments.html" title="Prismic::Fragments (module)">Fragments</a></span></span>
»
<span class="title">DocumentLink</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Prismic::Fragments::DocumentLink
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName"><span class='object_link'><a href="Link.html" title="Prismic::Fragments::Link (class)">Link</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Fragment.html" title="Prismic::Fragments::Fragment (class)">Fragment</a></span></li>
<li class="next"><span class='object_link'><a href="Link.html" title="Prismic::Fragments::Link (class)">Link</a></span></li>
<li class="next">Prismic::Fragments::DocumentLink</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2">Includes:</dt>
<dd class="r2"><span class='object_link'><a href="../WithFragments.html" title="Prismic::WithFragments (module)">WithFragments</a></span></dd>
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/prismic/fragments/link.rb</dd>
</dl>
<div class="clear"></div>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#broken-instance_method" title="#broken (instance method)">- (Object) <strong>broken</strong> </a>
(also: #broken?)
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute broken.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fragments-instance_method" title="#fragments (instance method)">- (Object) <strong>fragments</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute fragments.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#id-instance_method" title="#id (instance method)">- (Object) <strong>id</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute id.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#slug-instance_method" title="#slug (instance method)">- (Object) <strong>slug</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute slug.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tags-instance_method" title="#tags (instance method)">- (Object) <strong>tags</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute tags.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#type-instance_method" title="#type (instance method)">- (Object) <strong>type</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute type.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#uid-instance_method" title="#uid (instance method)">- (Object) <strong>uid</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute uid.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#as_html-instance_method" title="#as_html (instance method)">- (Object) <strong>as_html</strong>(link_resolver = nil) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#end_html-instance_method" title="#end_html (instance method)">- (Object) <strong>end_html</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (DocumentLink) <strong>initialize</strong>(id, uid, type, tags, slug, fragments, broken) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of DocumentLink.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#link_type-instance_method" title="#link_type (instance method)">- (Object) <strong>link_type</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#start_html-instance_method" title="#start_html (instance method)">- (Object) <strong>start_html</strong>(link_resolver) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#url-instance_method" title="#url (instance method)">- (Object) <strong>url</strong>(link_resolver) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the URL of the link.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../WithFragments.html" title="Prismic::WithFragments (module)">WithFragments</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../WithFragments.html#%5B%5D-instance_method" title="Prismic::WithFragments#[] (method)">#[]</a></span>, <span class='object_link'><a href="../WithFragments.html#as_text-instance_method" title="Prismic::WithFragments#as_text (method)">#as_text</a></span>, <span class='object_link'><a href="../WithFragments.html#each-instance_method" title="Prismic::WithFragments#each (method)">#each</a></span>, <span class='object_link'><a href="../WithFragments.html#first_title-instance_method" title="Prismic::WithFragments#first_title (method)">#first_title</a></span>, <span class='object_link'><a href="../WithFragments.html#get_color-instance_method" title="Prismic::WithFragments#get_color (method)">#get_color</a></span>, <span class='object_link'><a href="../WithFragments.html#get_date-instance_method" title="Prismic::WithFragments#get_date (method)">#get_date</a></span>, <span class='object_link'><a href="../WithFragments.html#get_embed-instance_method" title="Prismic::WithFragments#get_embed (method)">#get_embed</a></span>, <span class='object_link'><a href="../WithFragments.html#get_geopoint-instance_method" title="Prismic::WithFragments#get_geopoint (method)">#get_geopoint</a></span>, <span class='object_link'><a href="../WithFragments.html#get_group-instance_method" title="Prismic::WithFragments#get_group (method)">#get_group</a></span>, <span class='object_link'><a href="../WithFragments.html#get_image-instance_method" title="Prismic::WithFragments#get_image (method)">#get_image</a></span>, <span class='object_link'><a href="../WithFragments.html#get_link-instance_method" title="Prismic::WithFragments#get_link (method)">#get_link</a></span>, <span class='object_link'><a href="../WithFragments.html#get_number-instance_method" title="Prismic::WithFragments#get_number (method)">#get_number</a></span>, <span class='object_link'><a href="../WithFragments.html#get_slice_zone-instance_method" title="Prismic::WithFragments#get_slice_zone (method)">#get_slice_zone</a></span>, <span class='object_link'><a href="../WithFragments.html#get_structured_text-instance_method" title="Prismic::WithFragments#get_structured_text (method)">#get_structured_text</a></span>, <span class='object_link'><a href="../WithFragments.html#get_text-instance_method" title="Prismic::WithFragments#get_text (method)">#get_text</a></span>, <span class='object_link'><a href="../WithFragments.html#get_timestamp-instance_method" title="Prismic::WithFragments#get_timestamp (method)">#get_timestamp</a></span>, <span class='object_link'><a href="../WithFragments.html#length-instance_method" title="Prismic::WithFragments#length (method)">#length</a></span>, <span class='object_link'><a href="../WithFragments.html#linked_documents-instance_method" title="Prismic::WithFragments#linked_documents (method)">#linked_documents</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Fragment.html" title="Prismic::Fragments::Fragment (class)">Fragment</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Fragment.html#as_text-instance_method" title="Prismic::Fragments::Fragment#as_text (method)">#as_text</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="Prismic::Fragments::DocumentLink (class)">DocumentLink</a></span></tt>) <strong>initialize</strong>(id, uid, type, tags, slug, fragments, broken)
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of DocumentLink</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
101
102
103
104
105
106
107
108
109</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/link.rb', line 101</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_uid'>uid</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_tags'>tags</span><span class='comma'>,</span> <span class='id identifier rubyid_slug'>slug</span><span class='comma'>,</span> <span class='id identifier rubyid_fragments'>fragments</span><span class='comma'>,</span> <span class='id identifier rubyid_broken'>broken</span><span class='rparen'>)</span>
<span class='ivar'>@id</span> <span class='op'>=</span> <span class='id identifier rubyid_id'>id</span>
<span class='ivar'>@uid</span> <span class='op'>=</span> <span class='id identifier rubyid_uid'>uid</span>
<span class='ivar'>@type</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span>
<span class='ivar'>@tags</span> <span class='op'>=</span> <span class='id identifier rubyid_tags'>tags</span>
<span class='ivar'>@slug</span> <span class='op'>=</span> <span class='id identifier rubyid_slug'>slug</span>
<span class='ivar'>@fragments</span> <span class='op'>=</span> <span class='id identifier rubyid_fragments'>fragments</span>
<span class='ivar'>@broken</span> <span class='op'>=</span> <span class='id identifier rubyid_broken'>broken</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="broken=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="broken-instance_method">
- (<tt>Object</tt>) <strong>broken</strong>
<span class="aliases">Also known as:
<span class="names"><span id='broken?-instance_method'>broken?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute broken</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
99
100
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/link.rb', line 99</span>
<span class='kw'>def</span> <span class='id identifier rubyid_broken'>broken</span>
<span class='ivar'>@broken</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="fragments=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="fragments-instance_method">
- (<tt>Object</tt>) <strong>fragments</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute fragments</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
99
100
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/link.rb', line 99</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fragments'>fragments</span>
<span class='ivar'>@fragments</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="id=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="id-instance_method">
- (<tt>Object</tt>) <strong>id</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute id</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
99
100
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/link.rb', line 99</span>
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
<span class='ivar'>@id</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="slug=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="slug-instance_method">
- (<tt>Object</tt>) <strong>slug</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute slug</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
99
100
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/link.rb', line 99</span>
<span class='kw'>def</span> <span class='id identifier rubyid_slug'>slug</span>
<span class='ivar'>@slug</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="tags=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="tags-instance_method">
- (<tt>Object</tt>) <strong>tags</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute tags</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
99
100
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/link.rb', line 99</span>
<span class='kw'>def</span> <span class='id identifier rubyid_tags'>tags</span>
<span class='ivar'>@tags</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="type=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="type-instance_method">
- (<tt>Object</tt>) <strong>type</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute type</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
99
100
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/link.rb', line 99</span>
<span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
<span class='ivar'>@type</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="uid=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="uid-instance_method">
- (<tt>Object</tt>) <strong>uid</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute uid</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
99
100
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/link.rb', line 99</span>
<span class='kw'>def</span> <span class='id identifier rubyid_uid'>uid</span>
<span class='ivar'>@uid</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="as_html-instance_method">
- (<tt>Object</tt>) <strong>as_html</strong>(link_resolver = nil)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
119
120
121</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/link.rb', line 119</span>
<span class='kw'>def</span> <span class='id identifier rubyid_as_html'>as_html</span><span class='lparen'>(</span><span class='id identifier rubyid_link_resolver'>link_resolver</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
<span class='tstring'><span class='tstring_beg'>%(</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_start_html'>start_html</span><span class='lparen'>(</span><span class='id identifier rubyid_link_resolver'>link_resolver</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_slug'>slug</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_end_html'>end_html</span><span class='embexpr_end'>}</span><span class='tstring_end'>)</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="end_html-instance_method">
- (<tt>Object</tt>) <strong>end_html</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
115
116
117</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/link.rb', line 115</span>
<span class='kw'>def</span> <span class='id identifier rubyid_end_html'>end_html</span>
<span class='id identifier rubyid_broken?'>broken?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>%(</span><span class='tstring_content'></span></span><span class='tstring_end'>)</span></span> <span class='op'>:</span> <span class='kw'>super</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="link_type-instance_method">
- (<tt>Object</tt>) <strong>link_type</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
123
124
125
126</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/link.rb', line 123</span>
<span class='kw'>def</span> <span class='id identifier rubyid_link_type'>link_type</span>
<span class='id identifier rubyid_warn'>warn</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>WARNING: DocumentLink.link_type is deprecated, use DocumentLink.type instead</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="start_html-instance_method">
- (<tt>Object</tt>) <strong>start_html</strong>(link_resolver)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
111
112
113</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/link.rb', line 111</span>
<span class='kw'>def</span> <span class='id identifier rubyid_start_html'>start_html</span><span class='lparen'>(</span><span class='id identifier rubyid_link_resolver'>link_resolver</span><span class='rparen'>)</span>
<span class='id identifier rubyid_broken?'>broken?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>%(</span><span class='tstring_content'><span></span><span class='tstring_end'>)</span></span> <span class='op'>:</span> <span class='kw'>super</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="url-instance_method">
- (<tt>Object</tt>) <strong>url</strong>(link_resolver)
</h3><div class="docstring">
<div class="discussion">
<p>Returns the URL of the link</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>link_resolver</span>
<span class='type'>(<tt><span class='object_link'><a href="../LinkResolver.html" title="Prismic::LinkResolver (class)">LinkResolver</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="Link.html#url-instance_method" title="Prismic::Fragments::Link#url (method)">Link#url</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
135
136
137
138</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/link.rb', line 135</span>
<span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span><span class='lparen'>(</span><span class='id identifier rubyid_link_resolver'>link_resolver</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>A link_resolver method is needed to serialize document links into a correct URL on your website. If you're using a starter kit, a trivial one is provided out-of-the-box, that you can update later.</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_link_resolver'>link_resolver</span> <span class='op'>==</span> <span class='kw'>nil</span>
<span class='id identifier rubyid_link_resolver'>link_resolver</span><span class='period'>.</span><span class='id identifier rubyid_link_to'>link_to</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Sep 27 10:47:07 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.4 (ruby-2.0.0).
</div>
</body>
</html>