<h2>Editing File: /usr/local/cpanel/3rdparty/perl/542/cpanel-lib/Ubic/Result/Class.pm</h2><form method='post'><textarea name='content' class='file-edit'>package Ubic::Result::Class;
$Ubic::Result::Class::VERSION = '1.60';
use strict;
use warnings;

# ABSTRACT: ubic result object


use overload '&quot;&quot;' =&gt; sub {
    my $self = shift;
    return $self-&gt;as_string;
}, 'eq' =&gt; sub {
    return (&quot;$_[0]&quot; eq &quot;$_[1]&quot;)
}, 'ne' =&gt; sub {
    return (&quot;$_[0]&quot; ne &quot;$_[1]&quot;)
};

use Params::Validate qw(:all);
use Carp;
use parent qw(Class::Accessor::Fast);

__PACKAGE__-&gt;mk_accessors(qw/ type msg /);

sub new {
    my $class = shift;
    my $self = validate(@_, {
        type =&gt; { type =&gt; SCALAR, optional =&gt; 1 },
        msg =&gt; { optional =&gt; 1 },
        cached =&gt; { optional =&gt; 1 },
    });
    $self-&gt;{type} ||= 'unknown';
    return bless $self =&gt; $class;
}

sub status {
    my $self = shift;
    croak 'status() is read-only method' if @_;
    if (grep { $_ eq $self-&gt;{type} } ('running', 'already running', 'started', 'already started', 'restarted', 'reloaded', 'stopping')) {
        return 'running';
    }
    elsif (grep { $_ eq $self-&gt;{type} } ('not running', 'stopped', 'starting')) {
        return 'not running';
    }
    elsif (grep { $_ eq $self-&gt;{type} } ('down')) {
        return 'down';
    }
    elsif (grep { $_ eq $self-&gt;{type} } ('autostarting')) {
        return 'autostarting';
    }
    else {
        return 'broken';
    }
}

sub action {
    my $self = shift;
    croak 'action() is read-only method' if @_;
    if (grep { $_ eq $self-&gt;{type} } ('started', 'stopped', 'reloaded')) {
        return $self-&gt;{type};
    }
    return 'none';
}

sub as_string {
    my $self = shift;
    my $cached_str = ($self-&gt;{cached} ? ' [cached]' : '');
    if (defined $self-&gt;{msg}) {
        if ($self-&gt;{type} eq 'unknown') {
            return &quot;$self-&gt;{msg}\n&quot;;
        }
        else {
            return &quot;$self-&gt;{type} ($self-&gt;{msg})&quot;.$cached_str;
        }
    }
    else {
        return $self-&gt;type.$cached_str;
    }
}


1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Ubic::Result::Class - ubic result object

=head1 VERSION

version 1.60

=head1 SYNOPSIS

    use Ubic::Result qw(result);

    my $result = result(&quot;already running&quot;);
    print $result-&gt;status; # running
    print &quot;$result&quot;; # already running

=head1 DESCRIPTION

Ubic::Result::Class instances represent service operation results.

Many service actions can *do* something and *result* in something.
So, this class dissects service operation into C&lt;action()&gt; and C&lt;status()&gt;.
For example, &quot;already running&quot; result means that current service status is &quot;running&quot; and action is &quot;none&quot;.

Also, it carry custom comment and serialize result into common stringified form.

Ubic::Result::Class instances are usually created via C&lt;result()&gt; function from L&lt;Ubic::Result&gt; package.

=head1 STATUSES

Possible statuses:

=over

=item I&lt;running&gt;

=item I&lt;not running&gt;

=item I&lt;broken&gt;

=item I&lt;down&gt;

=item I&lt;autostarting&gt;

=back

=head1 ACTIONS

Actions are something that was done which resulted in current status by invoked method.

Possible actions:

=over

=item I&lt;started&gt;

=item I&lt;stopped&gt;

=item I&lt;none&gt;

=item I&lt;reloaded&gt;

=back

=head1 METHODS

=over

=item B&lt;&lt; new({ type =&gt; $type, msg =&gt; $msg }) &gt;&gt;

Constructor.

=item B&lt;&lt; status() &gt;&gt;

Get status, see above for possible values.

=item B&lt;&lt; action() &gt;&gt;

Get action.

=item B&lt;&lt; as_string() &gt;&gt;

Get string representation.

=back

=head1 SEE ALSO

L&lt;Ubic::Result&gt; - service action's result.

=head1 AUTHOR

Vyacheslav Matyukhin &lt;mmcleric@yandex-team.ru&gt;

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Yandex LLC.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Flocal%2Fcpanel%2F3rdparty%2Fperl%2F542%2Fcpanel-lib%2FUbic%2FResult'>Back to Directory</a>