File Coverage

blib/lib/Net/EPP/Frame/Command.pm

Criterion	Covered	Total	%
statement	36	65	55.3
branch	0	4	0.0
condition			n/a
subroutine	12	22	54.5
pod	2	8	25.0
total	50	99	50.5

# Copyright (c) 2016 CentralNic Ltd. All rights reserved. This program is
# free software; you can redistribute it and/or modify it under the same
# terms as Perl itself.
#
# $Id: Command.pm,v 1.4 2011/12/03 11:44:51 gavin Exp $
package Net::EPP::Frame::Command;
use Net::EPP::Frame::Command::Check;
use Net::EPP::Frame::Command::Create;
use Net::EPP::Frame::Command::Delete;
use Net::EPP::Frame::Command::Info;
use Net::EPP::Frame::Command::Login;
use Net::EPP::Frame::Command::Logout;
use Net::EPP::Frame::Command::Poll;
use Net::EPP::Frame::Command::Renew;
use Net::EPP::Frame::Command::Transfer;
use Net::EPP::Frame::Command::Update;
use base qw(Net::EPP::Frame);
use strict;

=pod

=head1 NAME

Net::EPP::Frame::Command - an instance of L for client commands

=head1 DESCRIPTION

This module is a base class for the Net::EPP::Frame::* subclasses, you should
never need to access it directly.

=head1 OBJECT HIERARCHY

    L
    +----L
        +----L
            +----L

=cut

sub new {
    my $package = shift;
    my $self    = $package->SUPER::new('command');
    return bless($self, $package);
}

sub addObject() {
    my ($self, $object, $ns, $schema) = @_;

    my $obj = $self->createElement($self->getCommandType);
    $obj->setNamespace($ns, $object);
    $self->getNode($self->getCommandType)->addChild($obj);

    return $obj;
}

sub _addExtraElements {
    my $self = shift;

    $self->command->addChild($self->createElement($self->getCommandType)) if ($self->getCommandType ne '');
    $self->command->addChild($self->createElement('clTRID'));

    $self->_addCommandElements;
    return 1;
}

sub _addCommandElements {
}

=pod

=head1 METHODS

	my $object = $frame->addObject(@spec);

This method creates and returns a new element corresponding to the data in
C<@spec>, and appends it to the "command" element (as returned by the
C method below).

The L module can be used to quickly retrieve EPP
object specifications.

	my $type = $frame->getCommandType;

This method returns a scalar containing the command type (eg L<'create'>).

	my $type = $frame->getCommandNode;

This method returns the L object corresponding to the
command in question, eg the CcreateE> element (for a
L object). It is within this element that
EPP objects are placed.

	my $node = $frame->command;

This method returns the L object corresponding to the
CcommandE> element.

	my $node = $frame->clTRID;

This method returns the L object corresponding to the
CclTRIDE> element.

=cut

sub getCommandType {
    my $self = shift;
    my $type = ref($self);
    my $me   = __PACKAGE__;
    $type =~ s/^$me\:+//;
    $type =~ s/\:{2}.+//;
    return lc($type);
}

sub getCommandNode {
    my $self = shift;
    return $self->getNode($self->getCommandType);
}

sub command { $_[0]->getNode('command') }
sub clTRID  { $_[0]->getNode('clTRID') }

=pod

    my $extension = $frame->extension;

This method returns the L object corresponding to the
CextensionE> element. If one does not exist, it will be created and
inserted at the correct position.

=cut

sub extension {
    my $self = shift;

    my $extension = $self->getNode('extension');

    $extension = $self->getCommandNode->parentNode->insertAfter($self->createElement('extension'), $self->getCommandNode) if (!$extension);

    return $extension;
}

=pod

    my $element = $frame->createExtensionElementFor($xmlns);

This methods creates a new element in the CextensionE> element for the
EPP extension specified by C<$xmlns> which can be obtained from
L. The element's tag name will correspond to the
command name (C, C etc).

    Example usage:

    my $frame = Net::EPP::Frame::Command::Info::Domain->new;

    my $element = $frame->createExtensionElementFor(
        Net::EPP::Frame::ObjectSpec->xmlns('foobar')
    );

    // prints
    print $element->toString();

=cut

sub createExtensionElementFor {
    my ($self, $xmlns) = @_;

    return $self->extension->appendChild($self->createElementNS($xmlns, $self->getCommandType));
}

1;