Added Newsletter Asset (Funded by United Knowledge)
This commit is contained in:
JT Smith
parent
245c7b947e
commit
9248570f79
16 changed files with 1295 additions and 149 deletions
242
lib/WebGUI/Asset/Wobject/Collaboration/Newsletter.pm
Normal file
242
lib/WebGUI/Asset/Wobject/Collaboration/Newsletter.pm
Normal file
|
|
@ -0,0 +1,242 @@
|
|||
package WebGUI::Asset::Wobject::Collaboration::Newsletter;
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
# 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
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
use strict;
|
||||
use Tie::IxHash;
|
||||
use WebGUI::Form;
|
||||
use WebGUI::International;
|
||||
use WebGUI::Utility;
|
||||
use base 'WebGUI::Asset::Wobject::Collaboration';
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 definition ( )
|
||||
|
||||
defines wobject properties for Newsletter instances. You absolutely need
|
||||
this method in your new Wobjects. If you choose to "autoGenerateForms", the
|
||||
getEditForm method is unnecessary/redundant/useless.
|
||||
|
||||
=cut
|
||||
|
||||
sub definition {
|
||||
my $class = shift;
|
||||
my $session = shift;
|
||||
my $definition = shift;
|
||||
my $i18n = WebGUI::International->new($session, 'Asset_Newsletter');
|
||||
my %properties;
|
||||
tie %properties, 'Tie::IxHash';
|
||||
%properties = (
|
||||
newsletterHeader => {
|
||||
defaultValue=>undef,
|
||||
fieldType=>"HTMLArea",
|
||||
tab=>"mail",
|
||||
label=>$i18n->get("newsletter header"),
|
||||
hoverHelp=>$i18n->get("newsletter header help"),
|
||||
},
|
||||
newsletterFooter => {
|
||||
defaultValue=>undef,
|
||||
fieldType=>"HTMLArea",
|
||||
tab=>"mail",
|
||||
label=>$i18n->get("newsletter footer"),
|
||||
hoverHelp=>$i18n->get("newsletter footer help"),
|
||||
},
|
||||
newsletterTemplateId => {
|
||||
defaultValue=>'newsletter000000000001',
|
||||
fieldType=>"template",
|
||||
namespace=>"newsletter",
|
||||
tab=>"mail",
|
||||
label=>$i18n->get("newsletter template"),
|
||||
hoverHelp=>$i18n->get("newsletter template help"),
|
||||
},
|
||||
mySubscriptionsTemplateId => {
|
||||
defaultValue=>'newslettersubscrip0001',
|
||||
fieldType=>"template",
|
||||
namespace=>"newsletter/mysubscriptions",
|
||||
tab=>"display",
|
||||
label=>$i18n->get("my subscriptions template"),
|
||||
hoverHelp=>$i18n->get("my subscriptions template help"),
|
||||
},
|
||||
);
|
||||
if ($session->setting->get("metaDataEnabled")) {
|
||||
$properties{newsletterCategories} = {
|
||||
defaultValue=>undef,
|
||||
fieldType=>"checkList",
|
||||
tab=>"properties",
|
||||
options=>$session->db->buildHashRef("select fieldId, fieldName from metaData_properties where
|
||||
fieldType in ('selectBox', 'checkList', 'radioList') order by fieldName"),
|
||||
label=>$i18n->get("newsletter categories"),
|
||||
hoverHelp=>$i18n->get("newsletter categories help"),
|
||||
vertical=>1,
|
||||
};
|
||||
}
|
||||
else {
|
||||
$properties{newsletterCategories} = {
|
||||
fieldType=>"readOnly",
|
||||
value=>'<b style="color: #800000;">'.$i18n->get("content profiling needed").'</b>',
|
||||
};
|
||||
}
|
||||
push(@{$definition}, {
|
||||
assetName=>$i18n->get('assetName'),
|
||||
icon=>'newsletter.gif',
|
||||
autoGenerateForms=>1,
|
||||
tableName=>'Newsletter',
|
||||
className=>'WebGUI::Asset::Wobject::Collaboration::Newsletter',
|
||||
properties=>\%properties
|
||||
});
|
||||
return $class->SUPER::definition($session, $definition);
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 duplicate ( )
|
||||
|
||||
duplicates a Newsletter. This method is unnecessary, but if you have
|
||||
auxiliary, ancillary, or "collateral" data or files related to your
|
||||
wobject instances, you will need to duplicate them here.
|
||||
|
||||
=cut
|
||||
|
||||
sub duplicate {
|
||||
my $self = shift;
|
||||
my $newAsset = $self->SUPER::duplicate(@_);
|
||||
return $newAsset;
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
sub getUserSubscriptions {
|
||||
my $self = shift;
|
||||
my $userId = shift || $self->session->user->userId;
|
||||
my ($subscriptionString) = $self->session->db->quickArray("select subscriptions from Newsletter_subscriptions where
|
||||
assetId=? and userId=?", [$self->getId, $userId]);
|
||||
return split("\n", $subscriptionString);
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
sub getViewTemplateVars {
|
||||
my $self = shift;
|
||||
my $var = $self->SUPER::getViewTemplateVars;
|
||||
$var->{mySubscriptionsUrl} = $self->getUrl("func=mySubscriptions");
|
||||
return $var;
|
||||
}
|
||||
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
sub purge {
|
||||
my $self = shift;
|
||||
$self->session->db->write("delete from Newsletter_subscriptions where assetId=?", [$self->getId]);
|
||||
$self->SUPER::purge(@_);
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
sub setUserSubscriptions {
|
||||
my $self = shift;
|
||||
my $subscriptions = shift;
|
||||
my $userId = shift || $self->session->user->userId;
|
||||
$self->session->db->write("replace into Newsletter_subscriptions (assetId, userId, subscriptions, lastSendTime)
|
||||
values (?,?,?,?)", [$self->getId, $userId, $subscriptions, time()]);
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 view ( )
|
||||
|
||||
method called by the www_view method. Returns a processed template
|
||||
to be displayed within the page style.
|
||||
|
||||
=cut
|
||||
|
||||
sub view {
|
||||
my $self = shift;
|
||||
my $session = $self->session;
|
||||
|
||||
#This automatically creates template variables for all of your wobject's properties.
|
||||
my $var = $self->getViewTemplateVars;
|
||||
|
||||
#This is an example of debugging code to help you diagnose problems.
|
||||
#WebGUI::ErrorHandler::warn($self->get("templateId"));
|
||||
|
||||
return $self->processTemplate($var, undef, $self->{_viewTemplate});
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_edit ( )
|
||||
|
||||
Web facing method which is the default edit page. This method is entirely
|
||||
optional. Take it out unless you specifically want to set a submenu in your
|
||||
adminConsole views.
|
||||
|
||||
=cut
|
||||
|
||||
sub www_edit {
|
||||
my $self = shift;
|
||||
return $self->session->privilege->insufficient() unless $self->canEdit;
|
||||
return $self->session->privilege->locked() unless $self->canEditIfLocked;
|
||||
my $i18n = WebGUI::International->new($self->session, "Asset_Newsletter");
|
||||
return $self->getAdminConsole->render($self->getEditForm->print, $i18n->get("edit title"));
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
sub www_mySubscriptions {
|
||||
my $self = shift;
|
||||
return $self->session->privilege->insufficient unless ($self->canView && $self->session->user->userId ne "1");
|
||||
my %var = ();
|
||||
my $meta = $self->getMetaDataFields;
|
||||
my @categories = ();
|
||||
my @userPrefs = $self->getUserSubscriptions;
|
||||
foreach my $id (keys %{$meta}) {
|
||||
my @options = ();
|
||||
if (isIn($id, split("\n", $self->get("newsletterCategories")))) {
|
||||
foreach my $option (split("\n", $meta->{$id}{possibleValues})) {
|
||||
$option =~ s/\s+$//; # remove trailing spaces
|
||||
next if $option eq ""; # skip blank values
|
||||
my $preferenceName = $id."~".$option;
|
||||
push(@options, {
|
||||
optionName => $option,
|
||||
optionForm => WebGUI::Form::checkbox($self->session, {
|
||||
name => "subscriptions",
|
||||
value => $preferenceName,
|
||||
checked => isIn($preferenceName, @userPrefs),
|
||||
})
|
||||
});
|
||||
}
|
||||
push (@categories, {
|
||||
categoryName => $meta->{$id}{fieldName},
|
||||
optionsLoop => \@options
|
||||
});
|
||||
}
|
||||
}
|
||||
$var{categoriesLoop} = \@categories;
|
||||
if (scalar(@categories)) {
|
||||
$var{formHeader} = WebGUI::Form::formHeader($self->session, {action=>$self->getUrl, method=>"post"})
|
||||
.WebGUI::Form::hidden($self->session, {name=>"func", value=>"mySubscriptionsSave"});
|
||||
$var{formFooter} = WebGUI::Form::formFooter($self->session);
|
||||
$var{formSubmit} = WebGUI::Form::submit($self->session);
|
||||
}
|
||||
return $self->processStyle($self->processTemplate(\%var, $self->get("mySubscriptionsTemplateId")));
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
sub www_mySubscriptionsSave {
|
||||
my $self = shift;
|
||||
return $self->session->privilege->insufficient unless ($self->canView && $self->session->user->userId ne "1");
|
||||
my $subscriptions = $self->session->form->process("subscriptions", "checkList");
|
||||
$self->setUserSubscriptions($subscriptions);
|
||||
return $self->www_view;
|
||||
}
|
||||
|
||||
1;
|
||||
Loading…
Add table
Add a link
Reference in a new issue