Adding documentation from Peace::DAO::Application
Fixed some types on the Developer's DAO doc.
This commit is contained in:
parent
ce8df4567b
commit
1061a5168a
|
|
@ -2,7 +2,7 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title />
|
||||
<title>Peace::DAO::Application - The database access object of applications.</title>
|
||||
<meta content="text/html; charset=utf-8" http-equiv="content-type" />
|
||||
<link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" />
|
||||
</head>
|
||||
|
|
@ -11,6 +11,87 @@
|
|||
|
||||
|
||||
|
||||
<ul id="index">
|
||||
<li><a href="#NAME">NAME</a></li>
|
||||
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
|
||||
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
|
||||
<li><a href="#INSTANCE-METHODS">INSTANCE METHODS</a>
|
||||
<ul>
|
||||
<li><a href="#new">new</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#METHODS">METHODS</a>
|
||||
<ul>
|
||||
<li><a href="#create">create</a></li>
|
||||
<li><a href="#recover_by_uuid">recover_by_uuid</a></li>
|
||||
<li><a href="#recover_by_developer">recover_by_developer</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
|
||||
</ul>
|
||||
|
||||
<h1 id="NAME">NAME</h1>
|
||||
|
||||
<p>Peace::DAO::Application - The database access object of applications.</p>
|
||||
|
||||
<h1 id="SYNOPSIS">SYNOPSIS</h1>
|
||||
|
||||
<pre><code>my $application_dao = Peace::DAO::Application->new(
|
||||
dbh => $dbh,
|
||||
);
|
||||
|
||||
$application_dao->create( application => $application );
|
||||
|
||||
my $application = $application_dao->recover_by_uuid( uuid => $uuid);
|
||||
|
||||
my $applications = $application_dao->recover_by_developer( developer => $developer );</code></pre>
|
||||
|
||||
<h1 id="DESCRIPTION">DESCRIPTION</h1>
|
||||
|
||||
<p>Peace::DAO::Developer allows you to make database operations over the applications table like recover or create.</p>
|
||||
|
||||
<h1 id="INSTANCE-METHODS">INSTANCE METHODS</h1>
|
||||
|
||||
<p>Peace::DAO::Application implements the following instance methods:</p>
|
||||
|
||||
<h2 id="new">new</h2>
|
||||
|
||||
<pre><code>my $application_dao = Peace::DAO::Application->new(
|
||||
dbh => $dbh,
|
||||
);</code></pre>
|
||||
|
||||
<p>Instances a Peace::DAO::Application object.</p>
|
||||
|
||||
<h1 id="METHODS">METHODS</h1>
|
||||
|
||||
<p>Peace::DAO::Application implements the following methods:</p>
|
||||
|
||||
<h2 id="create">create</h2>
|
||||
|
||||
<pre><code>$application_dao->create( application => $application );</code></pre>
|
||||
|
||||
<p>Takes a <a href="../Model/Application.pm.html">Peace::Model::Application</a> and creates its representation in database.</p>
|
||||
|
||||
<h2 id="recover_by_uuid">recover_by_uuid</h2>
|
||||
|
||||
<pre><code>my $application = $application_dao->recover_by_uuid(
|
||||
uuid => $uuid,
|
||||
);</code></pre>
|
||||
|
||||
<p>Recovers from database a <a href="../Model/Application.pm.html">Peace::Model::Application</a> from its uuid.</p>
|
||||
|
||||
<h2 id="recover_by_developer">recover_by_developer</h2>
|
||||
|
||||
<pre><code>my $applications = $application_dao->recover_by_developer(
|
||||
developer => $developer,
|
||||
);</code></pre>
|
||||
|
||||
<p>Recovers a arrayref of <a href="../Model/Application.pm.html">Peace::Model::Application</a> from its <a href="../Model/Developer.pm.html">Peace::Model::Developer</a>.</p>
|
||||
|
||||
<h1 id="SEE-ALSO">SEE ALSO</h1>
|
||||
|
||||
<p><a href="../DB.pm.html">Peace::DB</a>, <a href="../Model/Developer.pm.html">Peace::Model::Developer</a>, <a href="../Model/Application.pm.html">Peace::Model::Application</a></p>
|
||||
|
||||
|
||||
</body>
|
||||
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ my $developer = $developer_dao->recover_by_uuid( uuid => $uuid );</code></
|
|||
|
||||
<pre><code>my $developer_dao = Peace::DAO::Developer->new( dbh => $dbh );</code></pre>
|
||||
|
||||
<p>Builds a Peace::DAO::Developer object.</p>
|
||||
<p>Builds a <a href="../Model/Developer.pm.html">Peace::Model::Developer</a> object.</p>
|
||||
|
||||
<h1 id="METHODS">METHODS</h1>
|
||||
|
||||
|
|
@ -69,7 +69,7 @@ my $developer = $developer_dao->recover_by_uuid( uuid => $uuid );</code></
|
|||
|
||||
<pre><code>my $developer = $developer_dao->recover_by_uuid( uuid => $uuid );</code></pre>
|
||||
|
||||
<p>Recovers the developer associated from an uuid from database.</p>
|
||||
<p>Recovers the <a href="../Model/Developer.pm.html">Peace::Model::Developer</a> associated from an uuid from database.</p>
|
||||
|
||||
<h1 id="SEE-ALSO">SEE ALSO</h1>
|
||||
|
||||
|
|
|
|||
|
|
@ -148,3 +148,71 @@ sub _dbh {
|
|||
return $self->{dbh};
|
||||
}
|
||||
1;
|
||||
=encoding utf8
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Peace::DAO::Application - The database access object of applications.
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
my $application_dao = Peace::DAO::Application->new(
|
||||
dbh => $dbh,
|
||||
);
|
||||
|
||||
$application_dao->create( application => $application );
|
||||
|
||||
my $application = $application_dao->recover_by_uuid( uuid => $uuid);
|
||||
|
||||
my $applications = $application_dao->recover_by_developer( developer => $developer );
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
Peace::DAO::Developer allows you to make database
|
||||
operations over the applications table like recover
|
||||
or create.
|
||||
|
||||
=head1 INSTANCE METHODS
|
||||
|
||||
Peace::DAO::Application implements the following instance methods:
|
||||
|
||||
=head2 new
|
||||
|
||||
my $application_dao = Peace::DAO::Application->new(
|
||||
dbh => $dbh,
|
||||
);
|
||||
|
||||
Instances a Peace::DAO::Application object.
|
||||
|
||||
=head1 METHODS
|
||||
|
||||
Peace::DAO::Application implements the following methods:
|
||||
|
||||
=head2 create
|
||||
|
||||
$application_dao->create( application => $application );
|
||||
|
||||
Takes a L<Peace::Model::Application> and creates its
|
||||
representation in database.
|
||||
|
||||
=head2 recover_by_uuid
|
||||
|
||||
my $application = $application_dao->recover_by_uuid(
|
||||
uuid => $uuid,
|
||||
);
|
||||
|
||||
Recovers from database a L<Peace::Model::Application>
|
||||
from its uuid.
|
||||
|
||||
=head2 recover_by_developer
|
||||
|
||||
my $applications = $application_dao->recover_by_developer(
|
||||
developer => $developer,
|
||||
);
|
||||
|
||||
Recovers a arrayref of L<Peace::Model::Application> from
|
||||
its L<Peace::Model::Developer>.
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
L<Peace::DB>, L<Peace::Model::Developer>, L<Peace::Model::Application>
|
||||
|
|
|
|||
|
|
@ -122,7 +122,7 @@ Peace::DAO::Developer implements the following instance methods:
|
|||
|
||||
my $developer_dao = Peace::DAO::Developer->new( dbh => $dbh );
|
||||
|
||||
Builds a Peace::DAO::Developer object.
|
||||
Builds a L<Peace::Model::Developer> object.
|
||||
|
||||
=head1 METHODS
|
||||
|
||||
|
|
@ -138,7 +138,7 @@ Creates a representation in database of the passed developer object.
|
|||
|
||||
my $developer = $developer_dao->recover_by_uuid( uuid => $uuid );
|
||||
|
||||
Recovers the developer associated from an uuid from database.
|
||||
Recovers the L<Peace::Model::Developer> associated from an uuid from database.
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue