NAME
WebService::GData - represent a base GData object.
SYNOPSIS
package WebService::MyService;
use WebService::GData;#strict/warnings turned on
use base 'WebService::GData';
#this is the base implementation of the __init method in WebService::GData
#it is call when new is used
#you should overwrite it if necessary.
sub __init {
my ($this,%params) = @_;
while(my ($prop,$val)=each %params){
$this->{$prop}=$val;
}
return $this;
}
WebService::GData::install_in_package([qw(firstname lastname age gender)],sub {
my $func = shift;
return sub {
my $this = shift;
return $this->{$func};
}
});
#the above is equal to writing these simple getters:
#sub firstname {
# my $this = shift;
# return $this->{firstname};
#}
#sub lastname {
# my $this = shift;
# return $this->{lastname};
#}
#sub age {
# my $this = shift;
# return $this->{age};
#}
#sub gender {
# my $this = shift;
# return $this->{gender};
#}
1;
use WebService::MyService;
#create an object
my $object = new WebService::MyService(name=>'test');
$object->name;#test
#overloaded string will dump the object with Data::Dumper;
print $object;#$VAR1 = bless( { 'name' => 'test' }, 'WebService::MyService' );DESCRIPTION
This package does not do much.It is a blueprint that you should inherit and extend.
It offers a basic hashed based object creation via the word new.
All sub classes should be hash based. If you want to pock into the instance, it's easy
but everything that is not documented should be considered private.
If you play around with undocumented properties/methods and that it changes,
upgrading to the new version with all the extra new killer features will be very hard to do.
so...
dont.
Mostly, you will want to look at the following abstract classes from which services extend their feature:
- WebService::GData::Base
- WebService::GData::ClientLogin
- WebService::GData::Error
- WebService::GData::Query
- WebService::GData::Feed
A service in progress:
CONSTRUCTOR
new
Takes an hash which keys will be attached to the instance.
You can also use install_in_package() to create setters/getters for these parameters.
Parameters:
Return:
Example:
use WebService::GData;
#create an object
my $object = new WebService::GData(firstname=>'doe',lastname=>'john',age=>'123');
$object->{firstname};#doeMETHODS
__init
This method is called by the constructor new().
This function receives the parameters set in new() and by default assign the key/values pairs to the instance.
You should overwrite it and add your own logic.
__to_string
This method overloads the stringification quotes to display a dump of the object by using Data::Dumper.
You should overwrite it should you need to create a specific output.
SUB
install_in_package
Install in the package the methods/subs specified. Mostly use to avoid writting boiler plate getter/setter methods.
Parameters:
subnames:ArrayRef-
The array reference should list the name of the function you want to install in the package.
callback:Sub-
The callback is a _sub_ that will receive the name of the function.
This callback should itself send back a function.
Return:
void
Example:
#install simple setters; it could also be setter/getters
WebService::GData::install_in_package([qw(firstname lastname age gender)],sub {
my $func = shift;#firstname then lastname then age...
return sub {
my $this = shift;
return $this->{$func};
}
});
#you can use in the package:
sub user_info {
my $this = shift;
return {
age => $this->age,
firstname=> $this->firstname,
lastname => $this->lastname,
gender => $this->gender
}
}CONFIGURATION AND ENVIRONMENT
none
DEPENDENCIES
none
INCOMPATIBILITIES
none
BUGS AND LIMITATIONS
If you do me the favor to _use_ this module and find a bug, please email me i will try to do my best to fix it (patches welcome)!
AUTHOR
shiriru <shirirulestheworld[arobas]gmail.com>
LICENSE AND COPYRIGHT
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.