summaryrefslogtreecommitdiff
path: root/lib/Net/Plesk/Method.pm
blob: b58f68a920586758a3ba3bdff7acc096513a31df (plain)
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
package Net::Plesk::Method;

use strict;

use vars qw( $VERSION @ISA $AUTOLOAD $DEBUG );

$VERSION = '0.01';

$DEBUG = 0;

my %char_entities = (
  '&' => '&',
  '<' => '&lt;',
  '>' => '&gt;',
);

=head1 NAME

Net::Plesk::Method - Perl base class for Plesk XML Remote API Method

=head1 SYNOPSIS

  @ISA = qw( Net::Plesk::Method );

=head1 DESCRIPTION

This module implements a base class for constructing requests using SWSOFT's
Plesk.

=head1 METHODS

=over 4

=item new

Creates a new Net::Plesk::Method object and initializes it.
=cut

sub new {
  my $proto = shift;
  my $class = ref($proto) || $proto;
  my $me;
  my $self = \$me;
  bless($self, $class);
  $self->init(@_);
  return $self;
}


=item encode

Returns the xml encoded entity

=cut

sub encode {
  my ($self,$value) = (shift,shift);
  $value =~ s/([&<>])/$char_entities{$1}/ge;
  return $value;
}

=back

=head1 BUGS

  Creepy crawlies.

=head1 SEE ALSO

SWSOFT Plesk Remote API documentation (1.4.0.0 or later)

=head1 AUTHOR

Jeff Finucane E<lt>jeff@cmh.netE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2006 Jeff Finucane

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

=cut

1;