Adding the modified documentation html to the repo.
This commit is contained in:
parent
57b73c1b14
commit
18fd0de544
|
|
@ -15,6 +15,11 @@
|
|||
<li><a href="#NAME">NAME</a></li>
|
||||
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
|
||||
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
|
||||
<li><a href="#FUNCTIONS">FUNCTIONS</a>
|
||||
<ul>
|
||||
<li><a href="#startup">startup</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h1 id="NAME">NAME</h1>
|
||||
|
|
@ -29,6 +34,14 @@
|
|||
|
||||
<p>Peace is the server backend for flatstore a shop to be able to sell or buy flatpak applications.</p>
|
||||
|
||||
<h1 id="FUNCTIONS">FUNCTIONS</h1>
|
||||
|
||||
<p>Peace implements the following functions:</p>
|
||||
|
||||
<h2 id="startup">startup</h2>
|
||||
|
||||
<p>For internal usage from Mojolicious.</p>
|
||||
|
||||
|
||||
</body>
|
||||
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
<title>Peace::Model::Application - The application object representation.</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" />
|
||||
</head>
|
||||
|
|
@ -11,6 +11,162 @@
|
|||
|
||||
|
||||
|
||||
<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="#uuid">uuid</a></li>
|
||||
<li><a href="#date_creation">date_creation</a></li>
|
||||
<li><a href="#name">name</a></li>
|
||||
<li><a href="#description">description</a></li>
|
||||
<li><a href="#url">url</a></li>
|
||||
<li><a href="#developer">developer</a></li>
|
||||
<li><a href="#price">price</a></li>
|
||||
<li><a href="#git_repo">git_repo</a></li>
|
||||
<li><a href="#flatpak_builder_file">flatpak_builder_file</a></li>
|
||||
<li><a href="#verified">verified</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
|
||||
</ul>
|
||||
|
||||
<h1 id="NAME">NAME</h1>
|
||||
|
||||
<p>Peace::Model::Application - The application object representation.</p>
|
||||
|
||||
<h1 id="SYNOPSIS">SYNOPSIS</h1>
|
||||
|
||||
<pre><code>my $application = Peace::Model::Application->new(
|
||||
name => $name,
|
||||
description => $description,
|
||||
url => $url,
|
||||
developer => $developer,
|
||||
price => $price,
|
||||
git_repo => $git_repo,
|
||||
flatpak_builder_file => $flatpak_builder_file,
|
||||
verified => $verified,
|
||||
);</code></pre>
|
||||
|
||||
<h1 id="DESCRIPTION">DESCRIPTION</h1>
|
||||
|
||||
<p>Describes a application from Peace for sale.</p>
|
||||
|
||||
<h1 id="INSTANCE-METHODS">INSTANCE METHODS</h1>
|
||||
|
||||
<p>Peace::Model::Application implements the following instance methods:</p>
|
||||
|
||||
<h2 id="new">new</h2>
|
||||
|
||||
<pre><code>my $application = Peace::Model::Application->new(
|
||||
uuid => $uuid, # optional
|
||||
date_creation => $date_creation, # optional
|
||||
name => $name,
|
||||
description => $description,
|
||||
url => $url,
|
||||
developer => $developer, # required or developer_uuid should be passed.
|
||||
developer_uuid => $developer_uuid, # required or developer should be passed.
|
||||
dbh => $dbh, # needed if developer_uuid is passed.
|
||||
price => $price,
|
||||
git_repo => $git_repo,
|
||||
flatpak_builder_file => $flatpak_builder_file,
|
||||
verified => $verified,
|
||||
);</code></pre>
|
||||
|
||||
<h1 id="METHODS">METHODS</h1>
|
||||
|
||||
<p>Peace::Model::Application implements the following methods:</p>
|
||||
|
||||
<h2 id="uuid">uuid</h2>
|
||||
|
||||
<pre><code>my $uuid = $application->uuid;
|
||||
|
||||
$application->uuid($uuid);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the application's uuid.</p>
|
||||
|
||||
<h2 id="date_creation">date_creation</h2>
|
||||
|
||||
<pre><code>my $date_creation = $application->date_creation;
|
||||
|
||||
$application->date_creation($date_creation);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the application's date_creation.</p>
|
||||
|
||||
<h2 id="name">name</h2>
|
||||
|
||||
<pre><code>my $name = $application->name;
|
||||
|
||||
$application->name($name);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the application's name.</p>
|
||||
|
||||
<h2 id="description">description</h2>
|
||||
|
||||
<pre><code>my $description = $application->description;
|
||||
|
||||
$application->description($description);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the application's description.</p>
|
||||
|
||||
<h2 id="url">url</h2>
|
||||
|
||||
<pre><code>my $url = $application->url;
|
||||
|
||||
$application->url($url);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the application's url.</p>
|
||||
|
||||
<h2 id="developer">developer</h2>
|
||||
|
||||
<pre><code>my $developer = $application->developer;
|
||||
|
||||
$application->developer($developer);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the application's developer which is a <a>Peace::Model::Developer</a>.</p>
|
||||
|
||||
<h2 id="price">price</h2>
|
||||
|
||||
<pre><code>my $price = $application->price;
|
||||
|
||||
$application->price($price);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the application's price.</p>
|
||||
|
||||
<h2 id="git_repo">git_repo</h2>
|
||||
|
||||
<pre><code>my $git_repo = $application->git_repo;
|
||||
|
||||
$application->git_repo($git_repo);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the application's git_repo.</p>
|
||||
|
||||
<h2 id="flatpak_builder_file">flatpak_builder_file</h2>
|
||||
|
||||
<pre><code>my $flatpak_builder_file = $application->flatpak_builder_file;
|
||||
|
||||
$application->flatpak_builder_file($flatpak_builder_file);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the application's flatpak_builder_file.</p>
|
||||
|
||||
<h2 id="verified">verified</h2>
|
||||
|
||||
<pre><code>my $verified = $application->verified;
|
||||
|
||||
$application->verified($verified);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the application's verified status.</p>
|
||||
|
||||
<h1 id="SEE-ALSO">SEE ALSO</h1>
|
||||
|
||||
<p><a>Peace::Model::Developer</a>, <a>Peace::DAO::Application</a></p>
|
||||
|
||||
|
||||
</body>
|
||||
|
||||
|
|
|
|||
|
|
@ -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>Peace::Model::Customer - The customer object representation</title>
|
||||
<title>Peace::Model::Customer - The customer object representation.</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" />
|
||||
</head>
|
||||
|
|
@ -33,7 +33,7 @@
|
|||
|
||||
<h1 id="NAME">NAME</h1>
|
||||
|
||||
<p>Peace::Model::Customer - The customer object representation</p>
|
||||
<p>Peace::Model::Customer - The customer object representation.</p>
|
||||
|
||||
<h1 id="SYNOPSIS">SYNOPSIS</h1>
|
||||
|
||||
|
|
@ -70,7 +70,7 @@
|
|||
|
||||
$customer->uuid($uuid);</code></pre>
|
||||
|
||||
<p>Allows to retrive and set the customer uuid.</p>
|
||||
<p>Allows to retrieve and set the customer uuid.</p>
|
||||
|
||||
<h2 id="date_creation">date_creation</h2>
|
||||
|
||||
|
|
@ -78,7 +78,7 @@ $customer->uuid($uuid);</code></pre>
|
|||
|
||||
$customer->date_creation($date_creation);</code></pre>
|
||||
|
||||
<p>Allows to retrive and set the customer date_creation.</p>
|
||||
<p>Allows to retrieve and set the customer date_creation.</p>
|
||||
|
||||
<h2 id="secret_bcrypt">secret_bcrypt</h2>
|
||||
|
||||
|
|
@ -86,7 +86,7 @@ $customer->date_creation($date_creation);</code></pre>
|
|||
|
||||
$customer->secret_bcrypt($secret_bcrypt);</code></pre>
|
||||
|
||||
<p>Allows to retrive and set the customer secret_bcrypt.</p>
|
||||
<p>Allows to retrieve and set the customer secret_bcrypt.</p>
|
||||
|
||||
<h2 id="stripe_id">stripe_id</h2>
|
||||
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
<title>Peace::Model::Developer - The developer object representation.</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rev="made" href="mailto:Alpine@build-edge-aarch64.nonet" />
|
||||
</head>
|
||||
|
|
@ -11,6 +11,154 @@
|
|||
|
||||
|
||||
|
||||
<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="#applications">applications</a></li>
|
||||
<li><a href="#uuid">uuid</a></li>
|
||||
<li><a href="#date_creation">date_creation</a></li>
|
||||
<li><a href="#secret_bcrypt">secret_bcrypt</a></li>
|
||||
<li><a href="#name">name</a></li>
|
||||
<li><a href="#surname">surname</a></li>
|
||||
<li><a href="#email">email</a></li>
|
||||
<li><a href="#stripe_id">stripe_id</a></li>
|
||||
<li><a href="#country">country</a></li>
|
||||
<li><a href="#verified">verified</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
|
||||
</ul>
|
||||
|
||||
<h1 id="NAME">NAME</h1>
|
||||
|
||||
<p>Peace::Model::Developer - The developer object representation.</p>
|
||||
|
||||
<h1 id="SYNOPSIS">SYNOPSIS</h1>
|
||||
|
||||
<pre><code>my $developer = Peace::Model::Developer->new(
|
||||
secret_bcrypt => $secret_bcrypt,
|
||||
name => $name,
|
||||
surname => $surname,
|
||||
email => $email,
|
||||
country => $country,
|
||||
verified => $verified,
|
||||
);</code></pre>
|
||||
|
||||
<h1 id="DESCRIPTION">DESCRIPTION</h1>
|
||||
|
||||
<p>Describes a developer capable of submit Applications to Peace and get money.</p>
|
||||
|
||||
<h1 id="INSTANCE-METHODS">INSTANCE METHODS</h1>
|
||||
|
||||
<p>Peace::Model::Developer implements the following instance methods:</p>
|
||||
|
||||
<h2 id="new">new</h2>
|
||||
|
||||
<pre><code>my $developer = Peace::Model::Developer->new(
|
||||
uuid => $uuid, # optional
|
||||
date_creation => $date_creation, # optional
|
||||
secret_bcrypt => $secret_bcrypt,
|
||||
name => $name,
|
||||
surname => $surname,
|
||||
email => $email,
|
||||
stripe_id => $stripe_id, # optional
|
||||
country => $country,
|
||||
verified => $verified,
|
||||
dbh => $dbh, # optional, allows to retrieve applications
|
||||
);</code></pre>
|
||||
|
||||
<h1 id="METHODS">METHODS</h1>
|
||||
|
||||
<p>Peace::Model::Developer implements the following methods:</p>
|
||||
|
||||
<h2 id="applications">applications</h2>
|
||||
|
||||
<pre><code>my $applications = $developer->applications;</code></pre>
|
||||
|
||||
<p>Allows to retrieve the developer's applications which is a arrayref of <a>Peace::Model::Application</a>.</p>
|
||||
|
||||
<h2 id="uuid">uuid</h2>
|
||||
|
||||
<pre><code>my $uuid = $developer->uuid;
|
||||
|
||||
$developer->uuid($uuid);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the developer uuid.</p>
|
||||
|
||||
<h2 id="date_creation">date_creation</h2>
|
||||
|
||||
<pre><code>my $date_creation = $developer->date_creation;
|
||||
|
||||
$developer->date_creation($date_creation);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the developer date_creation.</p>
|
||||
|
||||
<h2 id="secret_bcrypt">secret_bcrypt</h2>
|
||||
|
||||
<pre><code>my $secret_bcrypt = $developer->secret_bcrypt;
|
||||
|
||||
$developer->secret_bcrypt($secret_bcrypt);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the developer secret_bcrypt.</p>
|
||||
|
||||
<h2 id="name">name</h2>
|
||||
|
||||
<pre><code>my $name = $developer->name;
|
||||
|
||||
$developer->name($name);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the developer name.</p>
|
||||
|
||||
<h2 id="surname">surname</h2>
|
||||
|
||||
<pre><code>my $surname = $developer->surname;
|
||||
|
||||
$developer->surname($surname);</code></pre>
|
||||
|
||||
<h2 id="email">email</h2>
|
||||
|
||||
<pre><code>my $email = $developer->email;
|
||||
|
||||
$developer->email($email);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the developer email.</p>
|
||||
|
||||
<h2 id="stripe_id">stripe_id</h2>
|
||||
|
||||
<pre><code>my $stripe_id = $developer->stripe_id;
|
||||
|
||||
$developer->stripe_id($stripe_id);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the developer stripe_id.</p>
|
||||
|
||||
<h2 id="country">country</h2>
|
||||
|
||||
<pre><code>my $country = $developer->country;
|
||||
|
||||
$developer->country($country);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the developer country.</p>
|
||||
|
||||
<h2 id="verified">verified</h2>
|
||||
|
||||
<pre><code>my $verified = $developer->verified
|
||||
|
||||
$developer->verified($verified);</code></pre>
|
||||
|
||||
<p>Allows to retrieve and set the developer verified.</p>
|
||||
|
||||
<h1 id="SEE-ALSO">SEE ALSO</h1>
|
||||
|
||||
<p><a>Peace::DAO::Developer</a>, <a>Peace::Model::Application</a></p>
|
||||
|
||||
|
||||
</body>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue