From 18fd0de5441cdf794bee568d629c829645258905 Mon Sep 17 00:00:00 2001 From: sergiotarxz Date: Thu, 17 Mar 2022 17:41:34 +0100 Subject: [PATCH] Adding the modified documentation html to the repo. --- doc/lib/Peace.pm.html | 13 ++ doc/lib/Peace/Model/Application.pm.html | 158 +++++++++++++++++++++++- doc/lib/Peace/Model/Customer.pm.html | 10 +- doc/lib/Peace/Model/Developer.pm.html | 150 +++++++++++++++++++++- 4 files changed, 324 insertions(+), 7 deletions(-) diff --git a/doc/lib/Peace.pm.html b/doc/lib/Peace.pm.html index e6805e3..255e1f0 100644 --- a/doc/lib/Peace.pm.html +++ b/doc/lib/Peace.pm.html @@ -15,6 +15,11 @@
  • NAME
  • SYNOPSIS
  • DESCRIPTION
    • +
  • FUNCTIONS + +

    • NAME

    @@ -29,6 +34,14 @@

    Peace is the server backend for flatstore a shop to be able to sell or buy flatpak applications.

    +

    FUNCTIONS

    + +

    Peace implements the following functions:

    + +

    startup

    + +

    For internal usage from Mojolicious.

    + diff --git a/doc/lib/Peace/Model/Application.pm.html b/doc/lib/Peace/Model/Application.pm.html index 21f9514..3cf6c35 100644 --- a/doc/lib/Peace/Model/Application.pm.html +++ b/doc/lib/Peace/Model/Application.pm.html @@ -2,7 +2,7 @@ - +Peace::Model::Application - The application object representation. @@ -11,6 +11,162 @@ + + +

    NAME

    + +

    Peace::Model::Application - The application object representation.

    + +

    SYNOPSIS

    + +
    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,
+);
    + +

    DESCRIPTION

    + +

    Describes a application from Peace for sale.

    + +

    INSTANCE METHODS

    + +

    Peace::Model::Application implements the following instance methods:

    + +

    new

    + +
    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,
+);
    + +

    METHODS

    + +

    Peace::Model::Application implements the following methods:

    + +

    uuid

    + +
    my $uuid = $application->uuid;
+
+$application->uuid($uuid);
    + +

    Allows to retrieve and set the application's uuid.

    + +

    date_creation

    + +
    my $date_creation = $application->date_creation;
+
+$application->date_creation($date_creation);
    + +

    Allows to retrieve and set the application's date_creation.

    + +

    name

    + +
    my $name = $application->name;
+
+$application->name($name);
    + +

    Allows to retrieve and set the application's name.

    + +

    description

    + +
    my $description = $application->description;
+
+$application->description($description);
    + +

    Allows to retrieve and set the application's description.

    + +

    url

    + +
    my $url = $application->url;
+
+$application->url($url);
    + +

    Allows to retrieve and set the application's url.

    + +

    developer

    + +
    my $developer = $application->developer;
+
+$application->developer($developer);
    + +

    Allows to retrieve and set the application's developer which is a Peace::Model::Developer.

    + +

    price

    + +
    my $price = $application->price;
+
+$application->price($price);
    + +

    Allows to retrieve and set the application's price.

    + +

    git_repo

    + +
    my $git_repo = $application->git_repo;
+
+$application->git_repo($git_repo);
    + +

    Allows to retrieve and set the application's git_repo.

    + +

    flatpak_builder_file

    + +
    my $flatpak_builder_file = $application->flatpak_builder_file;
+
+$application->flatpak_builder_file($flatpak_builder_file);
    + +

    Allows to retrieve and set the application's flatpak_builder_file.

    + +

    verified

    + +
    my $verified = $application->verified;
+
+$application->verified($verified);
    + +

    Allows to retrieve and set the application's verified status.

    + +

    SEE ALSO

    + +

    Peace::Model::Developer, Peace::DAO::Application

    + diff --git a/doc/lib/Peace/Model/Customer.pm.html b/doc/lib/Peace/Model/Customer.pm.html index 69ea727..f65325e 100644 --- a/doc/lib/Peace/Model/Customer.pm.html +++ b/doc/lib/Peace/Model/Customer.pm.html @@ -2,7 +2,7 @@ -Peace::Model::Customer - The customer object representation +Peace::Model::Customer - The customer object representation. @@ -33,7 +33,7 @@

    NAME

    -

    Peace::Model::Customer - The customer object representation

    +

    Peace::Model::Customer - The customer object representation.

    SYNOPSIS

    @@ -70,7 +70,7 @@ $customer->uuid($uuid); -

    Allows to retrive and set the customer uuid.

    +

    Allows to retrieve and set the customer uuid.

    date_creation

    @@ -78,7 +78,7 @@ $customer->uuid($uuid); $customer->date_creation($date_creation); -

    Allows to retrive and set the customer date_creation.

    +

    Allows to retrieve and set the customer date_creation.

    secret_bcrypt

    @@ -86,7 +86,7 @@ $customer->date_creation($date_creation); $customer->secret_bcrypt($secret_bcrypt); -

    Allows to retrive and set the customer secret_bcrypt.

    +

    Allows to retrieve and set the customer secret_bcrypt.

    stripe_id

    diff --git a/doc/lib/Peace/Model/Developer.pm.html b/doc/lib/Peace/Model/Developer.pm.html index 21f9514..be72ed7 100644 --- a/doc/lib/Peace/Model/Developer.pm.html +++ b/doc/lib/Peace/Model/Developer.pm.html @@ -2,7 +2,7 @@ - +Peace::Model::Developer - The developer object representation. @@ -11,6 +11,154 @@ + + +

    NAME

    + +

    Peace::Model::Developer - The developer object representation.

    + +

    SYNOPSIS

    + +
    my $developer = Peace::Model::Developer->new(
+  secret_bcrypt => $secret_bcrypt,
+  name          => $name,
+  surname       => $surname,
+  email         => $email,
+  country       => $country,
+  verified      => $verified,
+);
    + +

    DESCRIPTION

    + +

    Describes a developer capable of submit Applications to Peace and get money.

    + +

    INSTANCE METHODS

    + +

    Peace::Model::Developer implements the following instance methods:

    + +

    new

    + +
    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
+);
    + +

    METHODS

    + +

    Peace::Model::Developer implements the following methods:

    + +

    applications

    + +
    my $applications = $developer->applications;
    + +

    Allows to retrieve the developer's applications which is a arrayref of Peace::Model::Application.

    + +

    uuid

    + +
    my $uuid = $developer->uuid;
+
+$developer->uuid($uuid);
    + +

    Allows to retrieve and set the developer uuid.

    + +

    date_creation

    + +
    my $date_creation = $developer->date_creation;
+
+$developer->date_creation($date_creation);
    + +

    Allows to retrieve and set the developer date_creation.

    + +

    secret_bcrypt

    + +
    my $secret_bcrypt = $developer->secret_bcrypt;
+
+$developer->secret_bcrypt($secret_bcrypt);
    + +

    Allows to retrieve and set the developer secret_bcrypt.

    + +

    name

    + +
    my $name = $developer->name;
+
+$developer->name($name);
    + +

    Allows to retrieve and set the developer name.

    + +

    surname

    + +
    my $surname = $developer->surname;
+
+$developer->surname($surname);
    + +

    email

    + +
    my $email = $developer->email;
+
+$developer->email($email);
    + +

    Allows to retrieve and set the developer email.

    + +

    stripe_id

    + +
    my $stripe_id = $developer->stripe_id;
+
+$developer->stripe_id($stripe_id);
    + +

    Allows to retrieve and set the developer stripe_id.

    + +

    country

    + +
    my $country = $developer->country;
+
+$developer->country($country);
    + +

    Allows to retrieve and set the developer country.

    + +

    verified

    + +
    my $verified = $developer->verified
+
+$developer->verified($verified);
    + +

    Allows to retrieve and set the developer verified.

    + +

    SEE ALSO

    + +

    Peace::DAO::Developer, Peace::Model::Application

    +