Linux ip-172-26-7-228 5.4.0-1103-aws #111~18.04.1-Ubuntu SMP Tue May 23 20:04:10 UTC 2023 x86_64
Your IP : 18.219.242.213
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><title>Lintian::Reporting::ResourceManager</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" title="blkbluw" type="text/css" href="../../_blkbluw.css" media="all" >
<link rel="alternate stylesheet" title="blkmagw" type="text/css" href="../../_blkmagw.css" media="all" >
<link rel="alternate stylesheet" title="blkcynw" type="text/css" href="../../_blkcynw.css" media="all" >
<link rel="alternate stylesheet" title="whtprpk" type="text/css" href="../../_whtprpk.css" media="all" >
<link rel="alternate stylesheet" title="whtnavk" type="text/css" href="../../_whtnavk.css" media="all" >
<link rel="alternate stylesheet" title="grygrnk" type="text/css" href="../../_grygrnk.css" media="all" >
<link rel="alternate stylesheet" title="whtgrng" type="text/css" href="../../_whtgrng.css" media="all" >
<link rel="alternate stylesheet" title="blkgrng" type="text/css" href="../../_blkgrng.css" media="all" >
<link rel="alternate stylesheet" title="grygrnw" type="text/css" href="../../_grygrnw.css" media="all" >
<link rel="alternate stylesheet" title="blkbluw" type="text/css" href="../../_blkbluw.css" media="all" >
<link rel="alternate stylesheet" title="whtpurk" type="text/css" href="../../_whtpurk.css" media="all" >
<link rel="alternate stylesheet" title="whtgrng" type="text/css" href="../../_whtgrng.css" media="all" >
<link rel="alternate stylesheet" title="grygrnw" type="text/css" href="../../_grygrnw.css" media="all" >
<script type="text/javascript" src="../../_podly.js"></script>
</head>
<body class='pod'>
<!-- start doc -->
<p class="backlinktop"><b><a name="___top" href="../../index.html" accesskey="1" title="All Documents"><<</a></b></p>
<div class='indexgroup'>
<ul class='indexList indexList1'>
<li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
<li class='indexItem indexItem1'><a href='#SYNOPSIS'>SYNOPSIS</a>
<li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
<li class='indexItem indexItem1'><a href='#CLASS_METHODS'>CLASS METHODS</a>
<li class='indexItem indexItem1'><a href='#INSTANCE_METHODS'>INSTANCE METHODS</a>
<li class='indexItem indexItem1'><a href='#AUTHOR'>AUTHOR</a>
</ul>
</div>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>
<p>Lintian::Reporting::ResourceManager -- A simple resource manager for html_reports</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SYNOPSIS"
>SYNOPSIS</a></h1>
<pre> use Lintian::Reporting::ResourceManager;
my $resMan = Lintian::Reporting::ResourceManager->new(
'html_dir' => 'path/to/HTML-root',
);
# Copy the resource
$resMan->install_resource('path/to/my-image.png', { install_method => 'copy'} );
# Move the resource
$resMan->install_resource('path/to/generated-styles.css');
print 'Image: ' . $resMan->resource_URL('my-image.png'), "\n";
print 'CSS: ' . $resMan->resource_URL('generated-styles.css'), "\n";</pre>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>
<p>A simple resource manager for Lintian's reporting tool, <b>html_reports</b>.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="CLASS_METHODS"
>CLASS METHODS</a></h1>
<dl>
<dt><a name="new(TYPE,_OPTS)"
>new(TYPE, OPTS)</a></dt>
<dd>
<p>Instantiates a new resource manager.</p>
<p>OPTS is a key-value list, which must contain the key "html_dir" set to the root of the HTML path. It is beneath this path that all resources will be installed</p>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="INSTANCE_METHODS"
>INSTANCE METHODS</a></h1>
<dl>
<dt><a name="install_resource(RESOURCE[,_OPT])"
>install_resource(RESOURCE[, OPT])</a></dt>
<dd>
<p>Installs RESOURCE into the html root. The resource may be renamed (based on content etc.).</p>
<p>Note that the basename of RESOURCE must be unique between all resources installed. See <a href="#resource_URL(RESOURCE_NAME)" class="podlinkpod"
>"resource_URL(RESOURCE_NAME)"</a>.</p>
<p>If OPT is given, it must be a hashref with 0 or more of the following keys (and values).</p>
<dl>
<dt><a name="install_method"
>install_method</a></dt>
<dd>
<p>Can be "copy" or "move" (default). If set to "move", the original file will be renamed into its new location. Otherwise, a copy is done and the original file is left in place.</p>
<dt><a name="source_file"
>source_file</a></dt>
<dd>
<p>By default, the path denoted by RESOURCE is both the resource name and the source file. This option can be used to install a given file as RESOURCE regardless of the basename of the source file.</p>
<p>If this is passed, RESOURCE must be a basename (i.e. without any slashes).</p>
</dd>
</dl>
<dt><a name="resource_URL(RESOURCE_NAME)"
>resource_URL(RESOURCE_NAME)</a></dt>
<dd>
<p>Returns the path (relative to the HTML root) to a resource installed via <a href="#install_resource(RESOURCE)" class="podlinkpod"
>"install_resource(RESOURCE)"</a>, where RESOURCE_NAME is the basename of the path given to install_resource.</p>
<dt><a name="resource_integrity_value(RESOURCE_NAME)"
>resource_integrity_value(RESOURCE_NAME)</a></dt>
<dd>
<p>Return a string that is valid in the "integrity" field of a <code><link></code> HTML tag. (See https://www.w3.org/TR/SRI/)</p>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="AUTHOR"
>AUTHOR</a></h1>
<p>Originally written by Niels Thykier <niels@thykier.net> for Lintian.</p>
<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p>
<!-- end doc -->
</body></html>
|