<?xml version="1.0" encoding="iso-8859-1"?>
<!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">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class EasyRdf_Serialiser_GraphViz</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class EasyRdf_Serialiser_GraphViz</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-vars">Vars</a>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Class to serialise an EasyRdf_Graph to GraphViz</p>
<p class="description"><p>Depends upon the GraphViz 'dot' command line tools to render images.</p><p>See http://www.graphviz.org/ for more information.</p></p>
<ul class="tags">
<li><span class="field">copyright:</span> Copyright (c) 2012 Nicholas J Humfrey</li>
<li><span class="field">license:</span> <a href="http://www.opensource.org/licenses/bsd-license.php">http://www.opensource.org/licenses/bsd-license.php</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_EasyRdf---Serialiser---GraphViz.php.html">/EasyRdf/Serialiser/GraphViz.php</a> (line <span class="field">50</span>)
</p>
<pre><a href="../EasyRdf/EasyRdf_Serialiser.html">EasyRdf_Serialiser</a>
|
--EasyRdf_Serialiser_GraphViz</pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result"><a href="../EasyRdf/EasyRdf_Serialiser_GraphViz.html">object EasyRdf_Serialiser_GraphViz</a></span>
<a href="#__construct" title="details" class="method-name">__construct</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#getAttribute" title="details" class="method-name">getAttribute</a>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#getDotCommand" title="details" class="method-name">getDotCommand</a>
()
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#getOnlyLabelled" title="details" class="method-name">getOnlyLabelled</a>
()
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#getUseLabels" title="details" class="method-name">getUseLabels</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#serialise" title="details" class="method-name">serialise</a>
(<span class="var-type">string</span> <span class="var-name">$graph</span>, <span class="var-type">string</span> <span class="var-name">$format</span>)
</div>
<div class="method-definition">
<span class="method-result"><a href="../EasyRdf/EasyRdf_Serialiser_GraphViz.html">object EasyRdf_Serialiser_GraphViz</a></span>
<a href="#setAttribute" title="details" class="method-name">setAttribute</a>
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result"><a href="../EasyRdf/EasyRdf_Serialiser_GraphViz.html">object EasyRdf_Serialiser_GraphViz</a></span>
<a href="#setDotCommand" title="details" class="method-name">setDotCommand</a>
(<span class="var-type">string</span> <span class="var-name">$cmd</span>)
</div>
<div class="method-definition">
<span class="method-result"><a href="../EasyRdf/EasyRdf_Serialiser_GraphViz.html">object EasyRdf_Serialiser_GraphViz</a></span>
<a href="#setOnlyLabelled" title="details" class="method-name">setOnlyLabelled</a>
(<span class="var-type"></span> <span class="var-name">$onlyLabelled</span>, <span class="var-type">bool</span> <span class="var-name">$useLabels</span>)
</div>
<div class="method-definition">
<span class="method-result"><a href="../EasyRdf/EasyRdf_Serialiser_GraphViz.html">object EasyRdf_Serialiser_GraphViz</a></span>
<a href="#setUseLabels" title="details" class="method-name">setUseLabels</a>
(<span class="var-type">bool</span> <span class="var-name">$useLabels</span>)
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../EasyRdf/EasyRdf_Serialiser.html">EasyRdf_Serialiser</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../EasyRdf/EasyRdf_Serialiser.html#var$_prefixes">EasyRdf_Serialiser::$_prefixes</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">62</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../EasyRdf/EasyRdf_Serialiser_GraphViz.html">object EasyRdf_Serialiser_GraphViz</a></span>
<span class="method-name">
__construct
</span>
()
</div>
</div>
<a name="methodgetAttribute" id="getAttribute"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getAttribute</span> (line <span class="line-number">175</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get an attribute of the GraphViz graph</p>
<ul class="tags">
<li><span class="field">return:</span> The value of the graph attribute</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
getAttribute
</span>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: Attribute name</span> </li>
</ul>
</div>
<a name="methodgetDotCommand" id="getDotCommand"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getDotCommand</span> (line <span class="line-number">87</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the path to the GraphViz 'dot' command</p>
<p class="description"><p>The default value is simply 'dot'</p></p>
<ul class="tags">
<li><span class="field">return:</span> The path to the 'dot' command.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
getDotCommand
</span>
()
</div>
</div>
<a name="methodgetOnlyLabelled" id="getOnlyLabelled"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getOnlyLabelled</span> (line <span class="line-number">145</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the state of the only Only Labelled option</p>
<ul class="tags">
<li><span class="field">return:</span> The current state of the Only Labelled option</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
getOnlyLabelled
</span>
()
</div>
</div>
<a name="methodgetUseLabels" id="getUseLabels"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getUseLabels</span> (line <span class="line-number">116</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the state of the use labels option</p>
<ul class="tags">
<li><span class="field">return:</span> The current state of the use labels option</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
getUseLabels
</span>
()
</div>
</div>
<a name="methodserialise" id="serialise"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">serialise</span> (line <span class="line-number">360</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Serialise an EasyRdf_Graph into a GraphViz dot document.</p>
<p class="description"><p>Supported output format names: dot, gif, png, svg</p></p>
<ul class="tags">
<li><span class="field">return:</span> The RDF in the new desired format.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
serialise
</span>
(<span class="var-type">string</span> <span class="var-name">$graph</span>, <span class="var-type">string</span> <span class="var-name">$format</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$graph</span><span class="var-description">: An EasyRdf_Graph object.</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$format</span><span class="var-description">: The name of the format to convert to.</span> </li>
</ul>
</div>
<a name="methodsetAttribute" id="setAttribute"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setAttribute</span> (line <span class="line-number">163</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set an attribute on the GraphViz graph</p>
<p class="description"><p>Example: $serialiser->setAttribute('rotate', 90);</p><p>See the GraphViz tool documentation for information about the available attributes.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../EasyRdf/EasyRdf_Serialiser_GraphViz.html">object EasyRdf_Serialiser_GraphViz</a></span>
<span class="method-name">
setAttribute
</span>
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: The name of the attribute</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: The value for the attribute</span> </li>
</ul>
</div>
<a name="methodsetDotCommand" id="setDotCommand"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setDotCommand</span> (line <span class="line-number">74</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the path to the GraphViz 'dot' command</p>
<p class="description"><p>Default is to search PATH for the command 'dot'.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../EasyRdf/EasyRdf_Serialiser_GraphViz.html">object EasyRdf_Serialiser_GraphViz</a></span>
<span class="method-name">
setDotCommand
</span>
(<span class="var-type">string</span> <span class="var-name">$cmd</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$cmd</span><span class="var-description">: The path to the 'dot' command.</span> </li>
</ul>
</div>
<a name="methodsetOnlyLabelled" id="setOnlyLabelled"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setOnlyLabelled</span> (line <span class="line-number">134</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Turn on/off the option to only display nodes and edges with labels</p>
<p class="description"><p>When this option is turned on, then only nodes (resources and literals) and edges (properties) will only be displayed if they have a label. You can use this option, to create concise, diagrams of your data, rather than the RDF.</p><p>This option is turned off by default.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../EasyRdf/EasyRdf_Serialiser_GraphViz.html">object EasyRdf_Serialiser_GraphViz</a></span>
<span class="method-name">
setOnlyLabelled
</span>
(<span class="var-type"></span> <span class="var-name">$onlyLabelled</span>, <span class="var-type">bool</span> <span class="var-name">$useLabels</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">bool</span>
<span class="var-name">$useLabels</span><span class="var-description">: A boolean value to enable/display only labelled items</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$onlyLabelled</span> </li>
</ul>
</div>
<a name="methodsetUseLabels" id="setUseLabels"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setUseLabels</span> (line <span class="line-number">105</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Turn on/off the option to display labels instead of URIs.</p>
<p class="description"><p>When this option is turned on, then labels for resources will be displayed instead of the full URI of a resource. This makes it simpler to create friendly diagrams that non-technical people can understand.</p><p>This option is turned off by default.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../EasyRdf/EasyRdf_Serialiser_GraphViz.html">object EasyRdf_Serialiser_GraphViz</a></span>
<span class="method-name">
setUseLabels
</span>
(<span class="var-type">bool</span> <span class="var-name">$useLabels</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">bool</span>
<span class="var-name">$useLabels</span><span class="var-description">: A boolean value to turn labels on and off</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 16 Jan 2013 19:16:37 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
</p>
</div></body>
</html>
distrib
>
Fedora
>
18
>
x86_64
>
media
>
updates
>
by-pkgid
>
d962d4ce803d7a8a95dd6087db1b62f4
>
files
>
34
