<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module RubyXL::RelationshipSupport - rubyXL 3.4.11</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="module">
<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="extends-section" class="nav-section">
<h3>Extended With Modules</h3>
<ul class="link-list">
<li><a class="extend" href="RelationshipSupport/ClassMehods.html">RubyXL::RelationshipSupport::ClassMehods</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-included">::included</a>
<li ><a href="#method-i-attach_relationship">#attach_relationship</a>
<li ><a href="#method-i-collect_related_objects">#collect_related_objects</a>
<li ><a href="#method-i-load_relationships">#load_relationships</a>
<li ><a href="#method-i-related_objects">#related_objects</a>
<li ><a href="#method-i-store_relationship">#store_relationship</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-RubyXL::RelationshipSupport">
<h1 id="module-RubyXL::RelationshipSupport" class="module">
module RubyXL::RelationshipSupport
</h1>
<section class="description">
<p><code>RelationshipSupport</code> module enables automatic loading and saving of _rels for the respective file</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-generic_storage" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">generic_storage</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-relationship_container" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">relationship_container</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-included" class="method-detail ">
<div class="method-heading">
<span class="method-name">included</span><span
class="method-args">(klass)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="included-source">
<pre><span class="ruby-comment"># File lib/rubyXL/objects/relationships.rb, line 147</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">included</span>(<span class="ruby-identifier">klass</span>)
<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">class_variable_set</span>(<span class="ruby-value">:@@ooxml_relationships</span>, {})
<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">extend</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">RelationshipSupport</span><span class="ruby-operator">::</span><span class="ruby-constant">ClassMehods</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-attach_relationship" class="method-detail ">
<div class="method-heading">
<span class="method-name">attach_relationship</span><span
class="method-args">(rid, rf)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="attach_relationship-source">
<pre><span class="ruby-comment"># File lib/rubyXL/objects/relationships.rb, line 187</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">attach_relationship</span>(<span class="ruby-identifier">rid</span>, <span class="ruby-identifier">rf</span>)
<span class="ruby-identifier">relationships</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">class_variable_get</span>(<span class="ruby-value">:@@ooxml_relationships</span>)
<span class="ruby-identifier">klass</span> = <span class="ruby-identifier">rf</span>.<span class="ruby-identifier">class</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">relationships</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">klass</span>) <span class="ruby-keyword">then</span>
<span class="ruby-identifier">accessor</span> = <span class="ruby-identifier">relationships</span>[<span class="ruby-identifier">klass</span>]
<span class="ruby-keyword">case</span> <span class="ruby-identifier">accessor</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">NilClass</span> <span class="ruby-keyword">then</span>
<span class="ruby-comment"># Relationship is known, but we don't have a special accessor for it, store as generic</span>
<span class="ruby-identifier">store_relationship</span>(<span class="ruby-identifier">rf</span>)
<span class="ruby-keyword">when</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">then</span>
<span class="ruby-comment"># Do nothing, the code will perform attaching on its own</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">container</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">accessor</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">container</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>) <span class="ruby-keyword">then</span> <span class="ruby-identifier">container</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">rf</span>
<span class="ruby-keyword">else</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">"#{accessor}="</span>, <span class="ruby-identifier">rf</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span> <span class="ruby-identifier">store_relationship</span>(<span class="ruby-identifier">rf</span>, <span class="ruby-value">:unknown</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-collect_related_objects" class="method-detail ">
<div class="method-heading">
<span class="method-name">collect_related_objects</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="collect_related_objects-source">
<pre><span class="ruby-comment"># File lib/rubyXL/objects/relationships.rb, line 158</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">collect_related_objects</span>
<span class="ruby-identifier">res</span> = <span class="ruby-identifier">related_objects</span>.<span class="ruby-identifier">compact</span> <span class="ruby-comment"># Avoid tainting +related_objects+ array</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-identifier">generic_storage</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">generic_storage</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">relationship_container</span> <span class="ruby-keyword">then</span>
<span class="ruby-identifier">relationship_container</span>.<span class="ruby-identifier">owner</span> = <span class="ruby-keyword">self</span>
<span class="ruby-identifier">res</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">relationship_container</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">related</span> = []
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">obj</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:empty?</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">related</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">obj</span>
<span class="ruby-identifier">related</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-identifier">obj</span>.<span class="ruby-identifier">collect_related_objects</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:collect_related_objects</span>)
}
<span class="ruby-identifier">related</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-load_relationships" class="method-detail ">
<div class="method-heading">
<span class="method-name">load_relationships</span><span
class="method-args">(dir_path, base_file_name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="load_relationships-source">
<pre><span class="ruby-comment"># File lib/rubyXL/objects/relationships.rb, line 178</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load_relationships</span>(<span class="ruby-identifier">dir_path</span>, <span class="ruby-identifier">base_file_name</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">relationship_container</span> = <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">OOXMLRelationshipsFile</span>.<span class="ruby-identifier">load_relationship_file</span>(<span class="ruby-identifier">dir_path</span>, <span class="ruby-identifier">base_file_name</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">relationship_container</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">relationship_container</span>.<span class="ruby-identifier">load_related_files</span>(<span class="ruby-identifier">dir_path</span>, <span class="ruby-identifier">base_file_name</span>).<span class="ruby-identifier">each_pair</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">rid</span>, <span class="ruby-identifier">related_file</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">attach_relationship</span>(<span class="ruby-identifier">rid</span>, <span class="ruby-identifier">related_file</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">related_file</span>
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-related_objects" class="method-detail ">
<div class="method-heading">
<span class="method-name">related_objects</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="related_objects-source">
<pre><span class="ruby-comment"># File lib/rubyXL/objects/relationships.rb, line 154</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">related_objects</span> <span class="ruby-comment"># Override this method</span>
[]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-store_relationship" class="method-detail ">
<div class="method-heading">
<span class="method-name">store_relationship</span><span
class="method-args">(related_file, unknown = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="store_relationship-source">
<pre><span class="ruby-comment"># File lib/rubyXL/objects/relationships.rb, line 208</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">store_relationship</span>(<span class="ruby-identifier">related_file</span>, <span class="ruby-identifier">unknown</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">generic_storage</span> <span class="ruby-operator">||=</span> []
<span class="ruby-keyword">if</span> <span class="ruby-identifier">unknown</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-constant">RubyXL</span>.<span class="ruby-identifier">class_variable_get</span>(<span class="ruby-value">:@@suppress_warnings</span>) <span class="ruby-keyword">then</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">"WARNING: #{self.class} is not aware how to process #{related_file.class}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">generic_storage</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">related_file</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.0.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>