POD fixes and removing debug output
This commit is contained in:
Wouter van Oijen
parent
f3346bd008
commit
2d9565775f
53 changed files with 267 additions and 215 deletions
|
|
@ -56,7 +56,7 @@ sub _stop {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 config ()
|
||||
=head2 config ( )
|
||||
|
||||
Returns a reference to the config object.
|
||||
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ sub countClick {
|
|||
|
||||
=head3 session
|
||||
|
||||
A reference to the current session
|
||||
A reference to the current session.
|
||||
|
||||
=head3 properties
|
||||
|
||||
|
|
@ -85,7 +85,7 @@ sub create {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 delete
|
||||
=head2 delete ( )
|
||||
|
||||
Deletes this ad space.
|
||||
|
||||
|
|
@ -178,7 +178,7 @@ sub getAds {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getId
|
||||
=head2 getId ( )
|
||||
|
||||
Returns the id of this object.
|
||||
|
||||
|
|
@ -241,7 +241,7 @@ sub newByName {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 session
|
||||
=head2 session ( )
|
||||
|
||||
Returns a reference to the current session.
|
||||
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ sub create {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 delete
|
||||
=head2 delete ( )
|
||||
|
||||
Deletes this ad.
|
||||
|
||||
|
|
@ -116,7 +116,7 @@ sub get {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getId
|
||||
=head2 getId ( )
|
||||
|
||||
Returns the id of this object.
|
||||
|
||||
|
|
@ -154,7 +154,7 @@ sub new {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 session
|
||||
=head2 session ( )
|
||||
|
||||
Returns a reference to the current session.
|
||||
|
||||
|
|
|
|||
|
|
@ -393,7 +393,7 @@ sub getAdminFunction {
|
|||
|
||||
Constructor.
|
||||
|
||||
=head2 session
|
||||
=head3 session
|
||||
|
||||
A reference to the current session.
|
||||
|
||||
|
|
@ -492,7 +492,7 @@ sub render {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 setHelp ( id[,namespace] )
|
||||
=head2 setHelp ( id [,namespace] )
|
||||
|
||||
Sets the _helpUrl to the urlized page.
|
||||
|
||||
|
|
@ -529,6 +529,12 @@ sub getHelp {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 session ( )
|
||||
|
||||
Returns a reference to the current session.
|
||||
|
||||
=cut
|
||||
|
||||
sub session {
|
||||
my $self = shift;
|
||||
return $self->{_session};
|
||||
|
|
@ -536,7 +542,7 @@ sub session {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 setIcon ( icon)
|
||||
=head2 setIcon ( icon )
|
||||
|
||||
Sets the _function icon to parameter.
|
||||
|
||||
|
|
|
|||
|
|
@ -126,7 +126,7 @@ sub duplicate {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 exportAssetData() ( )
|
||||
=head2 exportAssetData ( )
|
||||
|
||||
See WebGUI::AssetPackage::exportAssetData() for details.
|
||||
|
||||
|
|
@ -142,7 +142,7 @@ sub exportAssetData {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getEditForm ()
|
||||
=head2 getEditForm ( )
|
||||
|
||||
Returns the TabForm object that will be used in generating the edit page for this asset.
|
||||
|
||||
|
|
@ -278,7 +278,7 @@ sub purge {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 purgeCache ()
|
||||
=head2 purgeCache ( )
|
||||
|
||||
See WebGUI::Asset::purgeCache() for details.
|
||||
|
||||
|
|
|
|||
|
|
@ -108,7 +108,7 @@ sub generateThumbnail {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getEditForm ()
|
||||
=head2 getEditForm ( )
|
||||
|
||||
Returns the TabForm object that will be used in generating the edit page for this asset.
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ our @ISA = qw(WebGUI::Asset);
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 addChild
|
||||
=head2 addChild ( )
|
||||
|
||||
Overriding to limit the types of children allowed.
|
||||
|
||||
|
|
@ -54,7 +54,7 @@ sub addChild {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 addRevision
|
||||
=head2 addRevision ( )
|
||||
|
||||
Override the default method in order to deal with attachments.
|
||||
|
||||
|
|
@ -83,7 +83,7 @@ sub addRevision {
|
|||
});
|
||||
$newSelf->getThread->unmarkRead;
|
||||
return $newSelf;
|
||||
}
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
sub canAdd {
|
||||
|
|
@ -238,7 +238,7 @@ sub DESTROY {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 exportAssetData() ( )
|
||||
=head2 exportAssetData ( )
|
||||
|
||||
See WebGUI::AssetPackage::exportAssetData() for details.
|
||||
|
||||
|
|
@ -281,7 +281,7 @@ sub formatContent {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getAvatarUrl ( )
|
||||
=head2 getAvatarUrl ( )
|
||||
|
||||
Returns a URL to the owner's avatar.
|
||||
|
||||
|
|
@ -310,7 +310,7 @@ sub getAvatarUrl {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getDeleteUrl ( )
|
||||
=head2 getDeleteUrl ( )
|
||||
|
||||
Formats the url to delete a post.
|
||||
|
||||
|
|
@ -353,7 +353,7 @@ sub getImageUrl {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getPosterProfileUrl ( )
|
||||
=head2 getPosterProfileUrl ( )
|
||||
|
||||
Formats the url to view a users profile.
|
||||
|
||||
|
|
@ -521,7 +521,7 @@ sub getThumbnailUrl {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 hasRated ( )
|
||||
=head2 hasRated ( )
|
||||
|
||||
Returns a boolean indicating whether this user has already rated this post.
|
||||
|
||||
|
|
@ -543,7 +543,7 @@ sub hasRated {
|
|||
|
||||
=head2 indexContent ( )
|
||||
|
||||
Indexing the content of attachments and user defined fields. See WebGUI::Asset::indexContent() for additonal details.
|
||||
Indexing the content of attachments and user defined fields. See WebGUI::Asset::indexContent() for additonal details.
|
||||
|
||||
=cut
|
||||
|
||||
|
|
@ -607,7 +607,7 @@ sub isPoster {
|
|||
|
||||
=head2 isReply ( )
|
||||
|
||||
Returns a boolean indicating whether this post is a reply.
|
||||
Returns a boolean indicating whether this post is a reply.
|
||||
|
||||
=cut
|
||||
|
||||
|
|
@ -735,7 +735,7 @@ sub purge {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 purgeCache ()
|
||||
=head2 purgeCache ( )
|
||||
|
||||
See WebGUI::Asset::purgeCache() for details.
|
||||
|
||||
|
|
@ -775,7 +775,7 @@ sub rate {
|
|||
return undef unless ($rating == -1 || $rating == 1);
|
||||
unless ($self->hasRated) {
|
||||
$self->session->db->write("insert into Post_rating (assetId,userId,ipAddress,dateOfRating,rating) values ("
|
||||
.$self->session->db->quote($self->getId).", ".$self->session->db->quote($self->session->user->userId).", ".$self->session->db->quote($self->session->env->get("REMOTE_ADDR")).",
|
||||
.$self->session->db->quote($self->getId).", ".$self->session->db->quote($self->session->user->userId).", ".$self->session->db->quote($self->session->env->get("REMOTE_ADDR")).",
|
||||
".$self->session->datetime->time().", ".$self->session->db->quote($rating).")");
|
||||
my ($sum) = $self->session->db->quickArray("select sum(rating) from Post_rating where assetId=".$self->session->db->quote($self->getId));
|
||||
$self->update({rating=>$sum});
|
||||
|
|
@ -809,7 +809,7 @@ sub requestCommit {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 setParent ( newParent )
|
||||
=head2 setParent ( newParent )
|
||||
|
||||
We're overloading the setParent in Asset because we don't want posts to be able to be posted to anything other than other posts or threads.
|
||||
|
||||
|
|
@ -858,7 +858,7 @@ sub setStatusUnarchived {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 trash
|
||||
=head2 trash ( )
|
||||
|
||||
Moves post to the trash and updates reply counter on thread.
|
||||
|
||||
|
|
@ -882,7 +882,7 @@ sub trash {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 update
|
||||
=head2 update ( )
|
||||
|
||||
We overload the update method from WebGUI::Asset in order to handle file system privileges.
|
||||
|
||||
|
|
@ -1012,7 +1012,7 @@ sub www_edit {
|
|||
$var{'form.header'} .= WebGUI::Form::hidden($self->session, {name=>"proceed", value=>"showConfirmation"});
|
||||
if ($self->session->form->process("title") || $self->session->form->process("content") || $self->session->form->process("synopsis")) {
|
||||
$var{'preview.title'} = WebGUI::HTML::filter($self->session->form->process("title"),"all");
|
||||
($var{'preview.synopsis'}, $var{'preview.content'}) = $self->getSynopsisAndContent($self->session->form->process("synopsis","textarea"), $self->session->form->process("content","HTMLArea"));
|
||||
($var{'preview.synopsis'}, $var{'preview.content'}) = $self->getSynopsisAndContent($self->session->form->process("synopsis","textarea"), $self->session->form->process("content","HTMLArea"));
|
||||
$var{'preview.content'} = $self->formatContent($var{'preview.content'},$self->session->form->process("contentType"));
|
||||
for my $i (1..5) {
|
||||
$var{'preview.userDefined'.$i} = WebGUI::HTML::filter($self->session->form->process('userDefined'.$i),"macros");
|
||||
|
|
@ -1097,7 +1097,7 @@ sub www_edit {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_editSave ()
|
||||
=head2 www_editSave ( )
|
||||
|
||||
We're extending www_editSave() here to deal with editing a post that has been denied by the approval process. Our change will reassign the old working tag of this post to the user so that they can edit it.
|
||||
|
||||
|
|
@ -1111,7 +1111,7 @@ sub www_editSave {
|
|||
my $i18n = WebGUI::International->new($self->session, "Asset");
|
||||
return $self->session->style->userStyle($i18n->get("over max assets")) if ($self->session->config("maximumAssets") <= $count);
|
||||
}
|
||||
if ($self->session->form->param("assetId") ne "new" && $self->get("status") eq "pending") {
|
||||
if ($self->session->form->param("assetId") ne "new" && $self->get("status") eq "pending") {
|
||||
my $currentTag = WebGUI::VersionTag->getWorking($self->session, 1);
|
||||
if (defined $currentTag && $currentTag->getAssetCount > 0) {
|
||||
# play a little working tag switcheroo
|
||||
|
|
@ -1151,7 +1151,7 @@ sub www_rate {
|
|||
|
||||
Shows a confirmation message letting the user know their post has been submitted.
|
||||
|
||||
=cut
|
||||
=cut
|
||||
|
||||
sub www_showConfirmation {
|
||||
my $self = shift;
|
||||
|
|
|
|||
|
|
@ -149,7 +149,7 @@ sub definition {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getEditForm ()
|
||||
=head2 getEditForm ( )
|
||||
|
||||
Returns the TabForm object that will be used in generating the edit page for this asset.
|
||||
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@ sub processPropertiesFromFormPost {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getEditForm ()
|
||||
=head2 getEditForm ( )
|
||||
|
||||
Returns the TabForm object that will be used in generating the edit page for this asset.
|
||||
|
||||
|
|
|
|||
|
|
@ -121,7 +121,7 @@ The name of the table you wish to delete the data from.
|
|||
|
||||
=head3 keyName
|
||||
|
||||
The name of a column in the table. Is not checked for invalid input.
|
||||
The name of a column in the table. Is not checked for invalid input.
|
||||
|
||||
=head3 keyValue
|
||||
|
||||
|
|
@ -143,7 +143,7 @@ sub deleteCollateral {
|
|||
|
||||
=head2 confirm ( message,yesURL [,noURL,vitalComparison] )
|
||||
|
||||
Returns an HTML string that presents a link to confirm and a link to cancel an action, both Internationalized text.
|
||||
Returns an HTML string that presents a link to confirm and a link to cancel an action, both Internationalized text.
|
||||
|
||||
=head3 message
|
||||
|
||||
|
|
@ -179,7 +179,7 @@ sub confirm {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getCollateral ( tableName, keyName, keyValue )
|
||||
=head2 getCollateral ( tableName, keyName, keyValue )
|
||||
|
||||
Returns a hash reference containing a row of collateral data.
|
||||
|
||||
|
|
@ -325,7 +325,7 @@ sub processPropertiesFromFormPost {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 processStyle (output)
|
||||
=head2 processStyle ( output )
|
||||
|
||||
Returns output parsed under the current style.
|
||||
|
||||
|
|
@ -394,7 +394,7 @@ The name of the table to insert the data.
|
|||
|
||||
=head3 keyName
|
||||
|
||||
The column name of the primary key in the table specified above.
|
||||
The column name of the primary key in the table specified above.
|
||||
|
||||
=head3 properties
|
||||
|
||||
|
|
@ -406,7 +406,7 @@ If set to "1", a new sequenceNumber will be generated and inserted into the row.
|
|||
|
||||
=head3 useAssetId
|
||||
|
||||
If set to "1", the current assetId will be inserted into the table upon creation of a new row. Note that this means the table better have a assetId column. Defaults to "1".
|
||||
If set to "1", the current assetId will be inserted into the table upon creation of a new row. Note that this means the table better have a assetId column. Defaults to "1".
|
||||
|
||||
=head3 setName
|
||||
|
||||
|
|
@ -440,7 +440,7 @@ sub setCollateral {
|
|||
my ($seq) = $self->session->db->quickArray("select max(sequenceNumber) from $table where $setName=".$self->session->db->quote($setValue));
|
||||
$properties->{sequenceNumber} = $seq+1;
|
||||
}
|
||||
}
|
||||
}
|
||||
unless ($useAssetId eq "0") {
|
||||
$properties->{assetId} = $self->get("assetId");
|
||||
}
|
||||
|
|
@ -473,7 +473,7 @@ sub setCollateral {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_edit ()
|
||||
=head2 www_edit ( )
|
||||
|
||||
Returns an edit form for this asset.
|
||||
|
||||
|
|
|
|||
|
|
@ -153,7 +153,7 @@ sub duplicate {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 exportAssetData() ( )
|
||||
=head2 exportAssetData ( )
|
||||
|
||||
See WebGUI::AssetPackage::exportAssetData() for details.
|
||||
|
||||
|
|
|
|||
|
|
@ -968,7 +968,7 @@ sub purge {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 purgeCache ()
|
||||
=head2 purgeCache ( )
|
||||
|
||||
See WebGUI::Asset::purgeCache() for details.
|
||||
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ use WebGUI::Operation::Commerce;
|
|||
use WebGUI::Commerce::ShoppingCart;
|
||||
use WebGUI::Commerce::Item;
|
||||
use WebGUI::Utility;
|
||||
use Data::Dumper;
|
||||
#use Data::Dumper;
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -91,7 +91,7 @@ sub definition {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getEditForm ()
|
||||
=head2 getEditForm ( )
|
||||
|
||||
Returns the TabForm object that will be used in generating the edit page for this asset.
|
||||
|
||||
|
|
@ -153,7 +153,7 @@ sub prepareView {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 purgeCache ()
|
||||
=head2 purgeCache ( )
|
||||
|
||||
See WebGUI::Asset::purgeCache() for details.
|
||||
|
||||
|
|
@ -228,7 +228,7 @@ sub view {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_view ()
|
||||
=head2 www_view ( )
|
||||
|
||||
See WebGUI::Asset::Wobject::www_view() for details.
|
||||
|
||||
|
|
|
|||
|
|
@ -236,7 +236,7 @@ sub purge {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 purgeCache ()
|
||||
=head2 purgeCache ( )
|
||||
|
||||
See WebGUI::Asset::purgeCache() for details.
|
||||
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ sub definition {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getEditForm ()
|
||||
=head2 getEditForm ( )
|
||||
|
||||
Returns the TabForm object that will be used in generating the edit page for this asset.
|
||||
|
||||
|
|
|
|||
|
|
@ -204,7 +204,7 @@ sub purge {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 purgeCache ()
|
||||
=head2 purgeCache ( )
|
||||
|
||||
See WebGUI::Asset::purgeCache() for details.
|
||||
|
||||
|
|
@ -1077,7 +1077,7 @@ sub view {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_view ()
|
||||
=head2 www_view ( )
|
||||
|
||||
See WebGUI::Asset::Wobject::www_view() for details.
|
||||
|
||||
|
|
|
|||
|
|
@ -76,7 +76,7 @@ sub prepareView {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 purgeCache ()
|
||||
=head2 purgeCache ( )
|
||||
|
||||
See WebGUI::Asset::purgeCache() for details.
|
||||
|
||||
|
|
@ -90,7 +90,7 @@ sub purgeCache {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 view ()
|
||||
=head2 view ( )
|
||||
|
||||
See WebGUI::Asset::view() for details.
|
||||
|
||||
|
|
@ -170,7 +170,7 @@ sub view {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_view ()
|
||||
=head2 www_view ( )
|
||||
|
||||
See WebGUI::Asset::Wobject::www_view() for details.
|
||||
|
||||
|
|
|
|||
|
|
@ -313,7 +313,7 @@ sub purge {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 purgeCache ()
|
||||
=head2 purgeCache ( )
|
||||
|
||||
See WebGUI::Asset::purgeCache() for details.
|
||||
|
||||
|
|
@ -871,7 +871,7 @@ sub view {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_view ()
|
||||
=head2 www_view ( )
|
||||
|
||||
See WebGUI::Asset::Wobject::www_view() for details.
|
||||
|
||||
|
|
|
|||
|
|
@ -293,7 +293,7 @@ sub prepareView {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 purgeCache ()
|
||||
=head2 purgeCache ( )
|
||||
|
||||
See WebGUI::Asset::purgeCache() for details.
|
||||
|
||||
|
|
@ -494,7 +494,7 @@ sub _processQuery {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_view ()
|
||||
=head2 www_view ( )
|
||||
|
||||
See WebGUI::Asset::Wobject::www_view() for details.
|
||||
|
||||
|
|
|
|||
|
|
@ -25,15 +25,24 @@ Package WebGUI::Asset::Wobject::Search
|
|||
|
||||
Asset used to search WebGUI content.
|
||||
|
||||
=head2 definition ( $class, $definition )
|
||||
=head1 METHODS
|
||||
|
||||
These methods are available from this package:
|
||||
|
||||
=cut
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 definition ( class, definition )
|
||||
|
||||
This method defines all properties of a Search and is used to autogenerate most methods.
|
||||
|
||||
=head3 $class
|
||||
=head3 class
|
||||
|
||||
$class is used to make sure that inheritance works on Assets and Wobjects.
|
||||
|
||||
=head3 $definition
|
||||
=head3 definition
|
||||
|
||||
Definition hashref from subclasses.
|
||||
|
||||
|
|
@ -49,7 +58,6 @@ ID of a tempate from the Search namespace to display the search results.
|
|||
|
||||
=cut
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
sub definition {
|
||||
my $class = shift;
|
||||
my $session = shift;
|
||||
|
|
|
|||
|
|
@ -232,7 +232,7 @@ sub updateHistory {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_lock ()
|
||||
=head2 www_lock ( )
|
||||
|
||||
This is the same as doing an www_editSave without changing anything. It's here so that users can lock assets if they're planning on working on them, or they're working on some of the content offline.
|
||||
|
||||
|
|
@ -253,7 +253,7 @@ sub www_lock {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_manageRevisions ()
|
||||
=head2 www_manageRevisions ( )
|
||||
|
||||
Shows a list of the revisions for this asset.
|
||||
|
||||
|
|
|
|||
|
|
@ -459,7 +459,7 @@ sub error {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getAccountTemplateId ()
|
||||
=head2 getAccountTemplateId ( )
|
||||
|
||||
This method should be overridden by the subclass and should return the template ID for the display/edit account screen.
|
||||
|
||||
|
|
@ -471,7 +471,7 @@ sub getAccountTemplateId {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getAccountTemplateId ()
|
||||
=head2 getAccountTemplateId ( )
|
||||
|
||||
This method should be overridden by the subclass and should return the template ID for the create account screen.
|
||||
|
||||
|
|
@ -483,7 +483,7 @@ sub getCreateAccountTemplateId {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getAccountTemplateId ()
|
||||
=head2 getAccountTemplateId ( )
|
||||
|
||||
This method should be overridden by the subclass and should return the template ID for the login screen.
|
||||
|
||||
|
|
@ -495,7 +495,7 @@ sub getLoginTemplateId {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getParams ()
|
||||
=head2 getParams ( )
|
||||
|
||||
Returns a hash reference with the user's authentication information. This method uses data stored in the instance of the object.
|
||||
|
||||
|
|
@ -641,7 +641,7 @@ sub new {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 profile ()
|
||||
=head2 profile ( )
|
||||
|
||||
Sets or returns the Profile hash for a user.
|
||||
|
||||
|
|
|
|||
|
|
@ -164,7 +164,7 @@ sub parseKey {
|
|||
|
||||
=head2 session ( )
|
||||
|
||||
Returns a reference session.
|
||||
Returns a reference to the current session.
|
||||
|
||||
=cut
|
||||
|
||||
|
|
|
|||
|
|
@ -112,7 +112,7 @@ sub priceLineItem {
|
|||
my $quantity = shift;
|
||||
# this is the output of ShoppingCart->getItems (the \@normal arrayref).
|
||||
my $cartItems = shift;
|
||||
use Data::Dumper;
|
||||
#use Data::Dumper;
|
||||
# $self->session->errorHandler->warn('normal contents: '.Dumper($cartItems));
|
||||
# this is the default price of this event.
|
||||
my $price = $self->{_event}->{price};
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ sub cancelRecurringPayment {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 checkoutForm
|
||||
=head2 checkoutForm ( )
|
||||
|
||||
This must return a printRowsOnly'ed WebGUI::HTMLForm containing the fields for the checkout
|
||||
dat you want to collect. Do not include submit buttons. You probably want to override this
|
||||
|
|
@ -80,7 +80,7 @@ sub checkoutForm {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 configurationForm
|
||||
=head2 configurationForm ( )
|
||||
|
||||
This generates the configuration form that's displayed in the admin console. You must
|
||||
extend this method to include parameters specific to this payment module. To do so return
|
||||
|
|
@ -116,7 +116,7 @@ sub configurationForm {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 confirmRecurringTransaction
|
||||
=head2 confirmRecurringTransaction ( )
|
||||
|
||||
This method is called if your gateway signals you (ie. posts data to some URL) to confirm a
|
||||
recurring payment term has been processed. If this is the case, you probably want to store
|
||||
|
|
@ -133,7 +133,7 @@ sub confirmRecurringTransaction {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 confirmTransaction
|
||||
=head2 confirmTransaction ( )
|
||||
|
||||
This method is called when your gateway contacts a specific URL to notify you of the result of a
|
||||
transaction. You should override this method only if your gateway uses this kind of notification
|
||||
|
|
@ -147,7 +147,7 @@ sub confirmTransaction {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 connectionError
|
||||
=head2 connectionError ( )
|
||||
|
||||
Returns an error message if there was a connection error. You must override this method.
|
||||
|
||||
|
|
@ -159,7 +159,7 @@ sub connectionError {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 enabled
|
||||
=head2 enabled ( )
|
||||
|
||||
Returns a boolean indicating whether the plugin is enabled or not.
|
||||
|
||||
|
|
@ -187,7 +187,7 @@ sub get {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getEnabledPlugins
|
||||
=head2 getEnabledPlugins ( )
|
||||
|
||||
Returns a reference to an array of all enabled instantiated payment plugins.
|
||||
|
||||
|
|
@ -237,7 +237,7 @@ sub init {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 gatewayId
|
||||
=head2 gatewayId ( )
|
||||
|
||||
Returns the gatewayId of the transaction. You must override this method.
|
||||
|
||||
|
|
@ -276,7 +276,7 @@ sub getRecurringPaymentStatus {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 errorCode
|
||||
=head2 errorCode ( )
|
||||
|
||||
Returns the error code of the last submission.
|
||||
|
||||
|
|
@ -335,7 +335,7 @@ sub name {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 namespace
|
||||
=head2 namespace ( )
|
||||
|
||||
Returns the namespace of the plugin.
|
||||
|
||||
|
|
@ -394,7 +394,7 @@ sub recurringTransaction {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 resultCode
|
||||
=head2 resultCode ( )
|
||||
|
||||
Returns the result code of the transaction. You must override this method.
|
||||
|
||||
|
|
@ -407,7 +407,7 @@ sub resultCode {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 resultMessage
|
||||
=head2 resultMessage ( )
|
||||
|
||||
Returns the result message of the transaction. You must override this method.
|
||||
|
||||
|
|
@ -529,7 +529,7 @@ sub shippingDescription {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 supports
|
||||
=head2 supports ( )
|
||||
|
||||
Returns a hashref containg the types of payment the plugin supports. The hashref may contain:
|
||||
|
||||
|
|
@ -547,7 +547,7 @@ sub supports {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 transactionCompleted {
|
||||
=head2 transactionCompleted ( )
|
||||
|
||||
A boolean indicating whether the payment has been finished or not. You must override this method.
|
||||
|
||||
|
|
@ -560,7 +560,7 @@ sub transactionCompleted {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 transactionError
|
||||
=head2 transactionError ( )
|
||||
|
||||
Returns an error message if a transaction error has occurred. You must override this method.
|
||||
|
||||
|
|
@ -573,7 +573,7 @@ sub transactionError {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 transactionPending
|
||||
=head2 transactionPending ( )
|
||||
|
||||
A boolean indicating whether the payment is pending or not. You must override this method.
|
||||
|
||||
|
|
@ -586,7 +586,7 @@ sub transactionPending {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 validateFormData
|
||||
=head2 validateFormData ( )
|
||||
|
||||
This method checks the data entered in the checkoutForm. If an error has occurred this method must
|
||||
return an arrayref containing the errormessages tied to the errors. If everything's ok it will return
|
||||
|
|
|
|||
|
|
@ -156,6 +156,7 @@ A copy of the session object
|
|||
The namespace of the plugin.
|
||||
|
||||
=cut
|
||||
|
||||
sub init {
|
||||
my ($class, $self);
|
||||
$class = shift;
|
||||
|
|
|
|||
|
|
@ -287,6 +287,7 @@ A copy of the session object
|
|||
The namespace of the plugin.
|
||||
|
||||
=cut
|
||||
|
||||
sub init {
|
||||
my ($class, $self);
|
||||
$class = shift;
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ use WebGUI::Commerce::ShoppingCart;
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 calc
|
||||
=head2 calc ( )
|
||||
|
||||
Returns the calculated shipping cost. Your plugin must override this method.
|
||||
|
||||
|
|
@ -33,7 +33,7 @@ sub calc {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 description
|
||||
=head2 description ( )
|
||||
|
||||
Returns a description of the shipping configuration. Defaults to the name of your plugin
|
||||
if you do not overload this method.
|
||||
|
|
@ -46,7 +46,7 @@ sub description {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 configurationForm
|
||||
=head2 configurationForm ( )
|
||||
|
||||
This generates the configuration form that's displayed in the admin console. You must
|
||||
extend this method to include parameters specific to this payment module. To do so return
|
||||
|
|
@ -75,7 +75,7 @@ sub configurationForm {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 enabled
|
||||
=head2 enabled ( )
|
||||
|
||||
Returns a boolean indicating whether the plugin is enabled or not.
|
||||
|
||||
|
|
@ -103,7 +103,7 @@ sub get {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getOptions
|
||||
=head2 getOptions ( )
|
||||
|
||||
Returns a hash containing the parameters of a user configurable shipping method. If
|
||||
your shipping plugin has an options form you should overload this method.
|
||||
|
|
@ -116,7 +116,7 @@ sub getOptions {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getShippingItems
|
||||
=head2 getShippingItems ( )
|
||||
|
||||
Returns an arrayref containing the items, marked for shipping. If no items are set
|
||||
using setShippingOptions it this method will default to the shopping cart of the user.
|
||||
|
|
@ -141,7 +141,7 @@ sub getShippingItems {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getEnabledPlugins
|
||||
=head2 getEnabledPlugins ( )
|
||||
|
||||
Returns a reference to an array of all enabled instantiated payment plugins.
|
||||
|
||||
|
|
@ -195,7 +195,7 @@ sub init {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getShoppingCart
|
||||
=head2 getShoppingCart ( )
|
||||
|
||||
Returns a WebGUI::Commerce::ShoppingCart object of the current user.
|
||||
|
||||
|
|
@ -237,7 +237,7 @@ sub load {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 name
|
||||
=head2 name ( )
|
||||
|
||||
Returns the (display) name of the plugin. You must override this method.
|
||||
|
||||
|
|
@ -250,7 +250,7 @@ sub name {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 namespace
|
||||
=head2 namespace ( )
|
||||
|
||||
Returns the namespace of the plugin.
|
||||
|
||||
|
|
@ -262,7 +262,7 @@ sub namespace {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 optionsOk
|
||||
=head2 optionsOk ( )
|
||||
|
||||
Indicates whether the options loaded into the plugin (by using either setOptions or processOptionsForm)
|
||||
are correct. If your plugin is able of being configured by an options form you must overload this method.
|
||||
|
|
@ -305,7 +305,7 @@ sub prepend {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 processOptionsForm
|
||||
=head2 processOptionsForm ( )
|
||||
|
||||
Processes the submitted form variables from the optionsForm and stores them
|
||||
into the plugin. You only need to overload this method if your plugin is capable
|
||||
|
|
@ -318,7 +318,7 @@ sub processOptionsForm {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 session
|
||||
=head2 session ( )
|
||||
|
||||
Returns the cached, local session variable.
|
||||
|
||||
|
|
@ -366,7 +366,7 @@ sub setShippingItems {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 supportsTracking
|
||||
=head2 supportsTracking ( )
|
||||
|
||||
Returns a boolean indicating whether this plugin supports tracking of the shipment.
|
||||
Overload this method if your plugin does. Defaults to false.
|
||||
|
|
@ -379,7 +379,7 @@ sub supportsTracking {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 trackingInfo
|
||||
=head2 trackingInfo ( )
|
||||
|
||||
Returns a message containing information about the shipment tracking (ie. where the
|
||||
package is or something like that). If your plugin support these tracking, you probably
|
||||
|
|
@ -393,7 +393,7 @@ sub trackingInfo {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 trackingNumber
|
||||
=head2 trackingNumber ( )
|
||||
|
||||
Returns the tracking ID supplied by the shipment company. If your plugin supports tracking
|
||||
you'll have to overload this method. Defaults to undef.
|
||||
|
|
@ -406,7 +406,7 @@ sub trackingNumber {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 trackingUrl
|
||||
=head2 trackingUrl ( )
|
||||
|
||||
Returns the URL where the user can go to either fill in the tracking number or view the tracking
|
||||
info of his package. Overload this method if your plugin supports tracking. Defaults to undef.
|
||||
|
|
|
|||
|
|
@ -272,7 +272,7 @@ sub new {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 session
|
||||
=head2 session ( )
|
||||
|
||||
Returns the cached, local session variable.
|
||||
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ sub addItem {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 cancelTransaction
|
||||
=head2 cancelTransaction ( )
|
||||
|
||||
Cancels a recurring transaction. This is done by trying to cancel the subscription at the gateway
|
||||
using a Payment plugin. If this is succesfull the transaction is marked as canceled.
|
||||
|
|
@ -100,7 +100,7 @@ sub cancelTransaction {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 completeTransaction
|
||||
=head2 completeTransaction ( )
|
||||
|
||||
Sets the status of a transaction to 'Completed' and executes the handler for every item attached to
|
||||
the transction.
|
||||
|
|
@ -127,7 +127,7 @@ sub completeTransaction {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 delete
|
||||
=head2 delete ( )
|
||||
|
||||
Deletes the transaction from the database;
|
||||
|
||||
|
|
@ -163,6 +163,7 @@ The type of the item you want to remove.
|
|||
=cut
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
sub deleteItem {
|
||||
my ($self, $itemId, $itemType, $amount, @items);
|
||||
$self = shift;
|
||||
|
|
@ -297,7 +298,7 @@ sub getByGatewayId {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getItems
|
||||
=head2 getItems ( )
|
||||
|
||||
=cut
|
||||
|
||||
|
|
@ -465,7 +466,7 @@ sub new {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 pendingTransactions
|
||||
=head2 pendingTransactions ( )
|
||||
|
||||
Returns a reference to an array which contains transaction objects of all pending transactions.
|
||||
|
||||
|
|
@ -485,7 +486,7 @@ sub pendingTransactions {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 session
|
||||
=head2 session ( )
|
||||
|
||||
Returns the cached, local session variable.
|
||||
|
||||
|
|
@ -650,7 +651,7 @@ sub trackingNumber {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 transactionId
|
||||
=head2 transactionId ( )
|
||||
|
||||
Returns the transactionId of the transaction.
|
||||
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ These functions are available from this package:
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 AUTOLOAD ()
|
||||
=head2 AUTOLOAD ( )
|
||||
|
||||
Dynamically creates functions on the fly for all the different form control types.
|
||||
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ sub privateName {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 definition ( $session, [ additionalTerms ] )
|
||||
=head2 definition ( session, [ additionalTerms ] )
|
||||
|
||||
Defines the schema or parameters for a form field.
|
||||
|
||||
|
|
@ -526,7 +526,7 @@ sub prepareWrapper {
|
|||
|
||||
=head2 session ( )
|
||||
|
||||
Returns a reference to the session.
|
||||
Returns a reference to the current session.
|
||||
|
||||
=cut
|
||||
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ sub _uiLevelChecksOut {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 AUTOLOAD ()
|
||||
=head2 AUTOLOAD ( )
|
||||
|
||||
Dynamically creates functions on the fly for all the different form control types.
|
||||
|
||||
|
|
@ -95,7 +95,7 @@ sub AUTOLOAD {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 DESTROY ()
|
||||
=head2 DESTROY ( )
|
||||
|
||||
Disposes of the form object.
|
||||
|
||||
|
|
|
|||
|
|
@ -75,15 +75,15 @@ our $HELP = {
|
|||
my @activities = map { s/^WebGUI::Workflow::Activity:://; $_; }
|
||||
map { @{ $workflows{$_} } }
|
||||
keys %workflows;
|
||||
use Data::Dumper;
|
||||
$session->errorHandler->warn(Dumper \@activities);
|
||||
#use Data::Dumper;
|
||||
#$session->errorHandler->warn(Dumper \@activities);
|
||||
return map {
|
||||
my ($namespace, $tag) = ($_, $_);
|
||||
$tag =~ s/([a-z])([A-Z])/$1 $2/g; #Separate studly caps
|
||||
$tag =~ s/([A-Z]+(?![a-z]))/$1 /g; #Separate acronyms
|
||||
$tag = lc $tag;
|
||||
$namespace = join '', 'Workflow_Activity_', $namespace;
|
||||
$session->errorHandler->warn($tag.' '.$namespace);
|
||||
#$session->errorHandler->warn($tag.' '.$namespace);
|
||||
{ tag => "$tag",
|
||||
namespace => $namespace }
|
||||
} @activities;
|
||||
|
|
|
|||
|
|
@ -169,7 +169,7 @@ sub new {
|
|||
|
||||
=head2 session ( )
|
||||
|
||||
Returns the the session object.
|
||||
Returns a reference to the current session.
|
||||
|
||||
=cut
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ These methods are available from this class:
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 configurationForm
|
||||
=head2 configurationForm ( )
|
||||
|
||||
The configuration form part for this object. See WebGUI::Image::Graph for
|
||||
documentation.
|
||||
|
|
@ -116,7 +116,7 @@ sub configurationForm {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 draw
|
||||
=head2 draw ( )
|
||||
|
||||
Draws the graph.
|
||||
|
||||
|
|
@ -140,7 +140,7 @@ sub draw {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 drawAxis
|
||||
=head2 drawAxis ( )
|
||||
|
||||
Draws the axis.
|
||||
|
||||
|
|
@ -162,7 +162,7 @@ sub drawAxis {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 drawLabels
|
||||
=head2 drawLabels ( )
|
||||
|
||||
Draws the labels.
|
||||
|
||||
|
|
@ -206,7 +206,7 @@ sub drawLabels {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head drawRulers
|
||||
=head2 drawRulers ( )
|
||||
|
||||
Draws the rulers.
|
||||
|
||||
|
|
@ -231,7 +231,7 @@ sub drawRulers {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 formNamespace
|
||||
=head2 formNamespace ( )
|
||||
|
||||
Extends the form namespace for this object. See WebGUI::Image::Graph for
|
||||
documentation.
|
||||
|
|
@ -246,7 +246,7 @@ sub formNamespace {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getAxisColor
|
||||
=head2 getAxisColor ( )
|
||||
|
||||
Returns the color triplet for the axis. Defaults to '#222222'.
|
||||
|
||||
|
|
@ -260,7 +260,7 @@ sub getAxisColor {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getChartHeight
|
||||
=head2 getChartHeight ( )
|
||||
|
||||
Returns the height of the chart. Defaults to 200.
|
||||
|
||||
|
|
@ -274,7 +274,7 @@ sub getChartHeight {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getChartOffset
|
||||
=head2 getChartOffset ( )
|
||||
|
||||
Returns the coordinates of the top-left corner of the chart. he coordinates are
|
||||
contained in a hasref with keys 'x' and 'y'.
|
||||
|
|
@ -289,7 +289,7 @@ sub getChartOffset {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getChartWidth
|
||||
=head2 getChartWidth ( )
|
||||
|
||||
Returns the width of the chart. Defaults to 200.
|
||||
|
||||
|
|
@ -303,7 +303,7 @@ sub getChartWidth {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getConfiguration
|
||||
=head2 getConfiguration ( )
|
||||
|
||||
Returns a configuration hashref. See WebGUI::Image::Graph for documentation.
|
||||
|
||||
|
|
@ -327,7 +327,7 @@ sub getConfiguration {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getDrawMode
|
||||
=head2 getDrawMode ( )
|
||||
|
||||
Returns the drawmode. Currently supported are 'stacked' and 'sideBySide'.
|
||||
Defaults to 'sideBySide'.
|
||||
|
|
@ -342,7 +342,7 @@ sub getDrawMode {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getPixelsPerUnit
|
||||
=head2 getPixelsPerUnit ( )
|
||||
|
||||
Returns the number of pixels that correspond with one unit of the dataset
|
||||
values.
|
||||
|
|
@ -357,7 +357,7 @@ sub getPixelsPerUnit {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getRulerColor
|
||||
=head2 getRulerColor ( )
|
||||
|
||||
Returns the color triplet of the rulers in the graph. Defaults to '#777777'.
|
||||
|
||||
|
|
@ -371,7 +371,7 @@ sub getRulerColor {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getYGranularity
|
||||
=head2 getYGranularity ( )
|
||||
|
||||
Returns the granularity of the labels and rulers in the Y direction. Defaults to
|
||||
10. This is value is in terms of the values in the dataset and has no direct
|
||||
|
|
@ -387,7 +387,7 @@ sub getYGranularity {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getYLabels
|
||||
=head2 getYLabels ( )
|
||||
|
||||
Returns an arrayref containing the labels for the Y axis.
|
||||
|
||||
|
|
@ -406,7 +406,7 @@ sub getYLabels {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getYRange
|
||||
=head2 getYRange ( )
|
||||
|
||||
Returns the maxmimal value of the range that contains a whole number of times
|
||||
the y granularity and is bigger than the maximum value in the dataset.
|
||||
|
|
@ -652,7 +652,7 @@ sub setYGranularity {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 showAxis
|
||||
=head2 showAxis ( )
|
||||
|
||||
Returns a boolean indicating whether to draw the axis.
|
||||
|
||||
|
|
@ -667,7 +667,7 @@ sub showAxis {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 showLabels
|
||||
=head2 showLabels ( )
|
||||
|
||||
Returns a boolean indicating whether to draw the labels.
|
||||
|
||||
|
|
@ -682,7 +682,7 @@ sub showLabels {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 showRulers
|
||||
=head2 showRulers ( )
|
||||
|
||||
Returns a boolean indicating whether to draw the rulers.
|
||||
|
||||
|
|
|
|||
|
|
@ -139,7 +139,7 @@ sub new {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 session
|
||||
=head2 session ( )
|
||||
|
||||
Returns a reference to the current session.
|
||||
|
||||
|
|
|
|||
|
|
@ -125,7 +125,7 @@ sub delete {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head DESTROY ( )
|
||||
=head2 DESTROY ( )
|
||||
|
||||
Deconstructor.
|
||||
|
||||
|
|
|
|||
|
|
@ -239,7 +239,7 @@ sub create {
|
|||
);
|
||||
$message->head->delete("Return-Path");
|
||||
$message->head->add("Return-Path", "<". ($session->setting->get("mailReturnPath") || $from) . ">");
|
||||
my $type = $headers->{contentType};
|
||||
$type = $headers->{contentType};
|
||||
if ($session->config->get("emailOverride")) {
|
||||
my $to = $headers->{to};
|
||||
$to = "WebGUI Group ".$headers->{toGroup} if ($headers->{toGroup});
|
||||
|
|
|
|||
|
|
@ -32,19 +32,26 @@ Package WebGUI::Operation::Profile
|
|||
|
||||
Operational handler for viewing, editing and validating user profile data.
|
||||
|
||||
=head2 getRequiredProfileFields ( $session )
|
||||
=head1 METHODS
|
||||
|
||||
Returns an array of hashes for required profile fields. This array is ready
|
||||
to be used as template variables in the WebGUI template system.
|
||||
|
||||
=head3 $session
|
||||
|
||||
The current WebGUI session object.
|
||||
These methods are available from this package:
|
||||
|
||||
=cut
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getRequiredProfileFields ( session )
|
||||
|
||||
Returns an array of hashes for required profile fields. This array is ready
|
||||
to be used as template variables in the WebGUI template system.
|
||||
|
||||
=head3 session
|
||||
|
||||
The current WebGUI session object.
|
||||
|
||||
=cut
|
||||
|
||||
# Builds Extra form requirements for anonymous registration.
|
||||
sub getRequiredProfileFields {
|
||||
my $session = shift;
|
||||
|
|
@ -82,19 +89,19 @@ sub isDuplicateEmail {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 saveProfileFields ( $session, $u, $profile )
|
||||
=head2 saveProfileFields ( session, u, profile )
|
||||
|
||||
Saves profile data to a user's profile. Does not validate any of the data.
|
||||
|
||||
=head3 $session
|
||||
=head3 session
|
||||
|
||||
WebGUI session object
|
||||
|
||||
=head3 $user
|
||||
=head3 user
|
||||
|
||||
User object. Profile data will be placed in this user's profile.
|
||||
|
||||
=head4 $profile
|
||||
=head3 profile
|
||||
|
||||
Hash ref of profile data to save.
|
||||
|
||||
|
|
@ -110,7 +117,7 @@ sub saveProfileFields {
|
|||
}
|
||||
}
|
||||
|
||||
=head2 validateProfileData ( $session )
|
||||
=head2 validateProfileData ( session )
|
||||
|
||||
Validates profile data from the session form variables. Returns processed data, warnings
|
||||
and errors.
|
||||
|
|
@ -159,7 +166,7 @@ sub validateProfileData {
|
|||
return (\%data, $error, $warning);
|
||||
}
|
||||
|
||||
=head2 www_editProfile ( $session )
|
||||
=head2 www_editProfile ( session )
|
||||
|
||||
Provide a form where user profile data can be entered or edited. The subroutine
|
||||
makes a large set of template variables which are passed to a template for presentation
|
||||
|
|
@ -168,9 +175,9 @@ selectable.
|
|||
|
||||
Calls www_editProfileSave on submission.
|
||||
|
||||
=head3 $session
|
||||
=head3 session
|
||||
|
||||
=head3 $error
|
||||
A reference to the current session.
|
||||
|
||||
=cut
|
||||
|
||||
|
|
@ -213,7 +220,7 @@ sub www_editProfile {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_editProfileSave ( $session )
|
||||
=head2 www_editProfileSave ( session )
|
||||
|
||||
Validates all data submitted by www_editProfile. If errors or warnings are present,
|
||||
they are concatenated and sent back to www_editProfile for display and to let the user
|
||||
|
|
@ -239,7 +246,9 @@ sub www_editProfileSave {
|
|||
return WebGUI::Operation::Auth::www_auth($session);
|
||||
}
|
||||
|
||||
=head2 www_viewProfile ( $session )
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_viewProfile ( session )
|
||||
|
||||
View the profile data for a user by the userId specified by the form variable C<uid>.
|
||||
Validates that the user requesting the profile data is allowed to see it.
|
||||
|
|
@ -248,8 +257,6 @@ is PBtmpl0000000000000052. The template is not user selectable.
|
|||
|
||||
=cut
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
sub www_viewProfile {
|
||||
my $session = shift;
|
||||
my $u = WebGUI::User->new($session,$session->form->process("uid"));
|
||||
|
|
|
|||
|
|
@ -15,6 +15,8 @@ Package WebGUI::Operation::TransactionLog
|
|||
Operations for dealing with transactions from the WebGUI Commerce System.
|
||||
|
||||
=cut
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_viewPurchaseHistory ( errorMessage )
|
||||
|
|
|
|||
|
|
@ -35,21 +35,27 @@ Package WebGUI::Operation::User
|
|||
Operation for creating, deleting, editing and many other user related functions.
|
||||
|
||||
=cut
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 _submenu ( $session, $workarea [, $title, $help] )
|
||||
=head2 _submenu ( session, workarea [, title, help] )
|
||||
|
||||
Internal utility routine for setting up the Admin Console for User functions.
|
||||
|
||||
=head3 $workarea
|
||||
=head3 session
|
||||
|
||||
A reference to the current session.
|
||||
|
||||
=head3 workarea
|
||||
|
||||
The form and information to display to the administrator using the function.
|
||||
|
||||
=head3 $title
|
||||
=head3 title
|
||||
|
||||
Internationalized title for the Admin Console, looked up in the WebGUI namespace if it exists.
|
||||
|
||||
=head3 $help
|
||||
=head3 help
|
||||
|
||||
Help topic. If set, then a Help icon will be displayed as a link to that topic.
|
||||
|
||||
|
|
@ -86,20 +92,24 @@ sub _submenu {
|
|||
return $ac->render($workarea, $title);
|
||||
}
|
||||
|
||||
=head2 doUserSearch ( $session, $op, $returnPaginator, $userFilter )
|
||||
=head2 doUserSearch ( session, op, returnPaginator, userFilter )
|
||||
|
||||
Subroutine that actually performs the SQL search for users.
|
||||
|
||||
=head3 $op
|
||||
=head3 session
|
||||
|
||||
A reference to the current session.
|
||||
|
||||
=head3 op
|
||||
|
||||
The name of the calling operation, passed so that pagination links work correctly.
|
||||
|
||||
=head3 $returnPaginator
|
||||
=head3 returnPaginator
|
||||
|
||||
A boolean. If true, a paginator object is returned. Otherwise, a WebGUI::SQL
|
||||
statement handler is returned.
|
||||
|
||||
=head3 $userFilter
|
||||
=head3 userFilter
|
||||
|
||||
Array reference, used to screen out user names via a SQL "not in ()" clause.
|
||||
|
||||
|
|
@ -149,11 +159,15 @@ sub doUserSearch {
|
|||
|
||||
Form front-end and display for searching for users.
|
||||
|
||||
=head3 $op
|
||||
=head3 session
|
||||
|
||||
A reference to the current session.
|
||||
|
||||
=head3 op
|
||||
|
||||
The name of the calling operation, passed so that pagination links work correctly.
|
||||
|
||||
=head3 $params
|
||||
=head3 params
|
||||
|
||||
Hashref. A set of key,value pairs that will be hidden in the user search form.
|
||||
|
||||
|
|
@ -524,10 +538,14 @@ sub www_editUserKarmaSave {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_formUsers ( $session )
|
||||
=head2 www_formUsers ( session )
|
||||
|
||||
Form helper to pick a user from the system.
|
||||
|
||||
=head3 session
|
||||
|
||||
A reference to the current session.
|
||||
|
||||
=cut
|
||||
|
||||
sub www_formUsers {
|
||||
|
|
|
|||
|
|
@ -46,6 +46,10 @@ These methods are available from this class:
|
|||
|
||||
Sets an approval for a version tag.
|
||||
|
||||
=head3 session
|
||||
|
||||
A reference to the current session.
|
||||
|
||||
=cut
|
||||
|
||||
sub www_approveVersionTag {
|
||||
|
|
@ -472,7 +476,7 @@ sub www_manageRevisionsInTag {
|
|||
|
||||
Deletes a version tag and all asset revisions attached to it.
|
||||
|
||||
=head2 session
|
||||
=head3 session
|
||||
|
||||
A reference to the current session.
|
||||
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ Operation handler for managing workflows.
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_addWorkflow ()
|
||||
=head2 www_addWorkflow ( )
|
||||
|
||||
Allows the user to choose the type of workflow that's going to be created.
|
||||
|
||||
|
|
@ -72,7 +72,7 @@ sub www_addWorkflow {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 www_addWorkflowSave ()
|
||||
=head2 www_addWorkflowSave ( )
|
||||
|
||||
Saves the results from www_addWorkflow().
|
||||
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ sub create {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 delete ()
|
||||
=head2 delete ( )
|
||||
|
||||
Deletes this category and all fields attached to it.
|
||||
|
||||
|
|
@ -117,7 +117,7 @@ sub get {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getCategories ()
|
||||
=head2 getCategories ( )
|
||||
|
||||
Returns an array reference of all WebGUI::ProfileCategory objects in order of sequence. This is a class method.
|
||||
|
||||
|
|
@ -136,7 +136,7 @@ sub getCategories {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getFields ()
|
||||
=head2 getFields ( )
|
||||
|
||||
Returns an array reference of all WebGUI::ProfileField objects that are part of this category in order of sequence.
|
||||
|
||||
|
|
@ -153,7 +153,7 @@ sub getFields {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getId ()
|
||||
=head2 getId ( )
|
||||
|
||||
Returns the unique ID for this category.
|
||||
|
||||
|
|
@ -166,7 +166,7 @@ sub getId {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getLabel ()
|
||||
=head2 getLabel ( )
|
||||
|
||||
Returns the eval'd label for this category.
|
||||
|
||||
|
|
@ -179,7 +179,7 @@ sub getLabel {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 isEditable ()
|
||||
=head2 isEditable ( )
|
||||
|
||||
Returns a boolean indicating whether the category's fields may be edited by a user.
|
||||
|
||||
|
|
@ -193,7 +193,7 @@ sub isEditable {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 isProtected ()
|
||||
=head2 isProtected ( )
|
||||
|
||||
Returns a boolean indicating whether the category may be deleted.
|
||||
|
||||
|
|
@ -206,7 +206,7 @@ sub isProtected {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 isViewable ()
|
||||
=head2 isViewable ( )
|
||||
|
||||
Returns a boolean indicating whether the category's fields may be viewed by a user.
|
||||
|
||||
|
|
@ -220,7 +220,7 @@ sub isViewable {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 moveDown ()
|
||||
=head2 moveDown ( )
|
||||
|
||||
Moves this category down one position.
|
||||
|
||||
|
|
@ -240,7 +240,7 @@ sub moveDown {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 moveUp ()
|
||||
=head2 moveUp ( )
|
||||
|
||||
Moves this field up one position.
|
||||
|
||||
|
|
|
|||
|
|
@ -95,7 +95,7 @@ sub create {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 delete ()
|
||||
=head2 delete ( )
|
||||
|
||||
Deletes this field and all user data attached to it.
|
||||
|
||||
|
|
@ -167,7 +167,7 @@ sub formField {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 formProcess ()
|
||||
=head2 formProcess ( )
|
||||
|
||||
Returns the value retrieved from a form post.
|
||||
|
||||
|
|
@ -211,7 +211,7 @@ sub get {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getCategory ()
|
||||
=head2 getCategory ( )
|
||||
|
||||
Returns a WebGUI::ProfileCategory object for the category that this profile field belongs to.
|
||||
|
||||
|
|
@ -225,7 +225,7 @@ sub getCategory {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getEditableFields ()
|
||||
=head2 getEditableFields ( )
|
||||
|
||||
Returns an array reference of WebGUI::ProfileField objects that are marked "editable" or "required". This is a class method.
|
||||
|
||||
|
|
@ -242,7 +242,7 @@ sub getEditableFields {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getFields ()
|
||||
=head2 getFields ( )
|
||||
|
||||
Returns an array reference of WebGUI::ProfileField objects. This is a class method.
|
||||
|
||||
|
|
@ -259,7 +259,7 @@ sub getFields {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getId ()
|
||||
=head2 getId ( )
|
||||
|
||||
Returns the unique fieldName for this field.
|
||||
|
||||
|
|
@ -274,7 +274,7 @@ sub getId {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getLabel ()
|
||||
=head2 getLabel ( )
|
||||
|
||||
Returns the eval'd label for this field.
|
||||
|
||||
|
|
@ -287,7 +287,7 @@ sub getLabel {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getRequiredFields ()
|
||||
=head2 getRequiredFields ( )
|
||||
|
||||
Returns an array reference of WebGUI::ProfileField objects that are marked "required". This is a class method.
|
||||
|
||||
|
|
@ -304,7 +304,7 @@ sub getRequiredFields {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 isEditable ()
|
||||
=head2 isEditable ( )
|
||||
|
||||
Returns a boolean indicating whether this field may be editable by a user.
|
||||
|
||||
|
|
@ -318,7 +318,7 @@ sub isEditable {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 isProtected ()
|
||||
=head2 isProtected ( )
|
||||
|
||||
Returns a boolean indicating whether this field may be deleted.
|
||||
|
||||
|
|
@ -331,7 +331,7 @@ sub isProtected {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 isRequired ()
|
||||
=head2 isRequired ( )
|
||||
|
||||
Returns a boolean indicating whether this field is required when a user creates an account or updates their account.
|
||||
|
||||
|
|
@ -344,7 +344,7 @@ sub isRequired {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 isViewable ()
|
||||
=head2 isViewable ( )
|
||||
|
||||
Returns a boolean indicating whether this field may be viewed by a user.
|
||||
|
||||
|
|
@ -357,7 +357,7 @@ sub isViewable {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 moveDown ()
|
||||
=head2 moveDown ( )
|
||||
|
||||
Moves this field down one position within it's category.
|
||||
|
||||
|
|
@ -377,7 +377,7 @@ sub moveDown {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 moveUp ()
|
||||
=head2 moveUp ( )
|
||||
|
||||
Moves this field up one position within it's category.
|
||||
|
||||
|
|
|
|||
|
|
@ -737,7 +737,7 @@ sub rollback {
|
|||
|
||||
=head2 session ( )
|
||||
|
||||
Returns the session object reference.
|
||||
Returns a reference to the current session.
|
||||
|
||||
=cut
|
||||
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ sub getAssetIds {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getAsses ( )
|
||||
=head2 getAssets ( )
|
||||
|
||||
Returns an array reference containing asset objects for those that matched.
|
||||
|
||||
|
|
@ -95,7 +95,7 @@ sub getAssets {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getPaginatorResultSet ( )
|
||||
=head2 getPaginatorResultSet ( currentURL, paginateAfter, pageNumber, formVar )
|
||||
|
||||
Returns a paginator object containing the search result set data.
|
||||
|
||||
|
|
@ -318,6 +318,8 @@ sub search {
|
|||
|
||||
=head2 session ( )
|
||||
|
||||
Returns a reference to the current session.
|
||||
|
||||
=cut
|
||||
|
||||
sub session {
|
||||
|
|
|
|||
|
|
@ -96,7 +96,7 @@ sub canShowDebug {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 canShowPerformanceIndicators ()
|
||||
=head2 canShowPerformanceIndicators ( )
|
||||
|
||||
Returns true if the user meets the conditions to see performance indicators and performance indicators are enabled.
|
||||
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ These functions are available from this package:
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 AUTOLOAD ()
|
||||
=head2 AUTOLOAD ( )
|
||||
|
||||
Dynamically creates functions on the fly for all the different form control types.
|
||||
|
||||
|
|
@ -87,7 +87,7 @@ sub DESTROY {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 get ()
|
||||
=head2 get ( )
|
||||
|
||||
An alias for process()
|
||||
|
||||
|
|
@ -230,7 +230,9 @@ sub process {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 session
|
||||
=head2 session ( )
|
||||
|
||||
Returns a reference to the current session.
|
||||
|
||||
=cut
|
||||
|
||||
|
|
|
|||
|
|
@ -616,7 +616,7 @@ sub getHashref {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getId ()
|
||||
=head2 getId ( )
|
||||
|
||||
Returns the unique identifier of this storage location.
|
||||
|
||||
|
|
@ -629,7 +629,7 @@ sub getId {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getLastError ()
|
||||
=head2 getLastError ( )
|
||||
|
||||
Returns the most recently generated error message.
|
||||
|
||||
|
|
|
|||
|
|
@ -216,7 +216,7 @@ sub get {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getEditForm ()
|
||||
=head2 getEditForm ( )
|
||||
|
||||
Returns the form that will be used to edit the properties of an activity.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue