package WebGUI::AdSpace::Ad;
=head1 LEGAL
-------------------------------------------------------------------
WebGUI is Copyright 2001-2006 Plain Black Corporation.
-------------------------------------------------------------------
Please read the legal notices (docs/legal.txt) and the license
(docs/license.txt) that came with this distribution before using
this software.
-------------------------------------------------------------------
http://www.plainblack.com info@plainblack.com
-------------------------------------------------------------------
=cut
use strict;
use WebGUI::AdSpace;
use WebGUI::Storage::Image;
=head1 NAME
Package WebGUI::AdSpace::Ad
=head1 DESCRIPTION
This class provides an mechanism for manipulating an individual ad within an ad space.
=head1 SYNOPSIS
use WebGUI::AdSpace::Ad;
=head1 METHODS
These methods are available from this class:
=cut
#-------------------------------------------------------------------
=head2 create ( session, adSpaceId, properties )
=head3 session
A reference to the current session
=head3 adSpaceId
The unique id of an ad space to attach this ad to.
=head3 properties
The properties used to create this object. See the set() method for details.
=cut
sub create {
my $class = shift;
my $session = shift;
my $adSpaceId = shift;
my $properties = shift;
my $id = $session->db->setRow("advertisement","adId",{adSpaceId=>$adSpaceId, adId=>"new"});
my $self = $class->new($session, $id);
$self->set($properties);
return $self;
}
#-------------------------------------------------------------------
=head2 delete
Deletes this ad.
=cut
sub delete {
my $self = shift;
my $storage = WebGUI::Storage::Image->get($self->session, $self->get("storageId"));
$storage->delete if defined $storage;
$self->session->db->deleteRow("advertisement","adId",$self->getId);
$self = undef;
}
#-------------------------------------------------------------------
=head2 DESTROY ( )
Deconstructor.
=cut
sub DESTROY {
my $self = shift;
undef $self;
}
#-------------------------------------------------------------------
=head2 get ( name )
Returns the value of a property.
=head3 name
The name of the property to retrieve the value for.
=cut
sub get {
my $self = shift;
my $name = shift;
return $self->{_properties}{$name};
}
#-------------------------------------------------------------------
=head2 getId
Returns the id of this object.
=cut
sub getId {
my $self = shift;
return $self->{_properties}{adId};
}
#-------------------------------------------------------------------
=head2 new ( session, id )
Constructor.
=head3 session
A reference to the current session.
=head3 id
The unqiue ID of an ad.
=cut
sub new {
my $class = shift;
my $session = shift;
my $id = shift;
my $properties = $session->db->getRow("advertisement","adId",$id);
return undef unless $properties->{adId};
bless {_session=>$session, _properties=>$properties}, $class;
}
#-------------------------------------------------------------------
=head2 session
Returns a reference to the current session.
=cut
sub session {
my $self = shift;
return $self->{_session};
}
#-------------------------------------------------------------------
=head2 set ( properties )
Updates the properties of an ad space.
=head3 properties
A hash reference containing the properties to set.
=head4 title
A human readable name for this ad, which will be displayed in the ad, and in menus.
=head4 adText
A chunk of text, no longer than 255 characters that will be displayed in text ads.
=head4 storageId
The id of the storage location that holds the image for an image style ad.
=head4 richMedia
A chunk of HTML that will be inserted into the page for rich media ads.
=head4 ownerUserId
The user that owns this ad, and will be able to view reports for it, etc.
=head4 isActive
A boolean indicating whether the ad is active or not.
=head4 type
The type of ad this is. Defaults to 'text'. Choose from 'text', 'image', or 'rich'.
=head4 borderColor
The hex color to be used to display the border on a text based ad.
=head4 textColor
THe hex color to be used to display the text on a test based ad.
=head4 backgroundColor
The hex color to be used to display the background on a text based ad.
=head4 priority
An integer that will be used to scale the frequency of ad placement based upon traffic to your site. The lower the number, the more frequently it will be displayed. For example, on a site with an average of 1 impression per second, if you have two ads, one with a priority of 0 and another with a priority of 100, the first ad will be displayed 100 times more frequently than the second ad.
=head4 url
The URL that the user will be directed to when clicking on the ad. This is used in text and image based ads.
=head4 clicksBought
The number of clicks that have been purchased for this ad.
=head4 impressionsBought
The number of times the user has paid for this ad to be displayed on the site.
=cut
sub set {
my $self = shift;
my $properties = shift;
$self->{_properties}{title} = $properties->{title} || $self->{_properties}{title} || "Untitled";
$self->{_properties}{clicksBought} = $properties->{clicksBought} || $self->{_properties}{clicksBought};
$self->{_properties}{impressionsBought} = $properties->{impressionsBought} || $self->{_properties}{impressionsBought};
$self->{_properties}{url} = $properties->{url} || $self->{_properties}{url};
$self->{_properties}{adText} = $properties->{adText} || $self->{_properties}{adText};
$self->{_properties}{storageId} = $properties->{storageId} || $self->{_properties}{storageId};
$self->{_properties}{richMedia} = $properties->{richMedia} || $self->{_properties}{richMedia};
$self->{_properties}{ownerUserId} = $properties->{ownerUserId} || $self->{_properties}{ownerUserId} || "3";
$self->{_properties}{isActive} = exists $properties->{isActive} ? $properties->{isActive} : $self->{_properties}{isActive};
$self->{_properties}{type} = $properties->{type} || $self->{_properties}{type} || "text";
$self->{_properties}{borderColor} = $properties->{borderColor} || $self->{_properties}{borderColor} || "#000000";
$self->{_properties}{textColor} = $properties->{textColor} || $self->{_properties}{textColor} || "#000000";
$self->{_properties}{backgroundColor} = $properties->{backgroundColor} || $self->{_properties}{backgroundColor} || "#ffffff";
$self->{_properties}{priority} = $properties->{priority} || $self->{_properties}{priority} || "0";
# prerender the ad for faster display
my $adSpace = WebGUI::AdSpace->new($self->session, $self->get("adSpaceId"));
if ($self->get("type") eq "text") {
$self->{_properties}{renderedAd} = 'getId)
.'" style="text-decoration: none;">get("height") - 2).'px; color: '.$self->get("textColor")
.'; background-color: '.$self->get("backgroundColor")
.'; border: 1px solid '.$self->get("borderColor").';">'
.$self->get("title").'
'.$self->get("adText").'
';
} elsif ($self->get("type") eq "image") {
my $storage = WebGUI::Storage::Image->get($self->session, $self->get("storageId"));
$self->{_properties}{renderedAd} = 'getId).'">get("height").'px;">
.')