1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
# 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<Net::EPP::Frame> 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<XML::LibXML::Node>
+----L<XML::LibXML::Document>
+----L<Net::EPP::Frame>
+----L<Net::EPP::Frame::Command>
=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<getCommandType()> method below).
The L<Net::EPP::Frame::ObjectSpec> 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<XML::LibXML::Element> object corresponding to the
command in question, eg the C<E<lt>createE<gt>> element (for a
L<Net::EPP::Frame::Command::Create> object). It is within this element that
EPP objects are placed.
my $node = $frame->command;
This method returns the L<XML::LibXML::Element> object corresponding to the
C<E<lt>commandE<gt>> element.
my $node = $frame->clTRID;
This method returns the L<XML::LibXML::Element> object corresponding to the
C<E<lt>clTRIDE<gt>> 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<XML::LibXML::Element> object corresponding to the
C<E<lt>extensionE<gt>> 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 C<E<lt>extensionE<gt>> element for the
EPP extension specified by C<$xmlns> which can be obtained from
L<Net::EPP::Frame::ObjectSpec>. The element's tag name will correspond to the
command name (C<create>, C<update> etc).
Example usage:
my $frame = Net::EPP::Frame::Command::Info::Domain->new;
my $element = $frame->createExtensionElementFor(
Net::EPP::Frame::ObjectSpec->xmlns('foobar')
);
// prints <info xmlns="namespace:for:foobar"/>
print $element->toString();
=cut
sub createExtensionElementFor {
my ($self, $xmlns) = @_;
return $self->extension->appendChild($self->createElementNS($xmlns, $self->getCommandType));
}
1;
|
