The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
FWS-V2-1.13091122
River stage zero No dependents
++
/ FWS::V2::Legacy

NAME

FWS::V2::Legacy - Framework Sites version 2 compatibility and legacy methods and translations

VERSION

Version 1.13091122

SYNOPSIS

    use FWS::V2;

    my $fws = FWS::V2->new();

    $fws->domain('http://www.mynewdomain.com');
    $fws->secureDomain('https://www.mynewdomain.com');
    ...

DESCRIPTION

FWS version 2 legacy methods are here for compatibility from upgrade paths of 1.3 and will not be present in the next version of FWS. Most of the methods are deprecated for the most part because they are get/set subroutines that allow you to change something that you should not change after new() is called. In a worst case scenario if you REALLY needed to change a setting you could access it via $fws->{thesetting} = 'something' instead.

METHODS

addExtraHash

This was renamed to mergeExtra().

adminLoginId

Should NEVER be set manually, it will be set during processLogin(). Will return the current admin user logged in. If it is blank then no admin user is logged in and can be accessed via $fws->{adminLoginId};

adminPageId

The default value is set to 'admin', which would be accessed via yourdomain.com/admin. Should be set when calling new(adminURL=>'admin') and can be accessed via $fws->{adminURL};

adminPassword

Should be set when calling new(). This is only used for internal security for the first time log in, and is disabled once an admin account is created.

affiliateId

Is set by passing 'a' as a form value. Can be accessed via $fws->{affiliateId};

ajaxEnable

Deprecated here for backwards compatibility in code.

cookieDomainName

Should be set when calling new() and can be accessed via $fws->{cookieDomainName};

email

Is set when calling setSiteValues() and can be accessed via $fws->{email};

dataCacheFields

Deprecated. Internal only but was exported at one point so it is here for compatability

debug

Deprecated. All logging is handled via $fws->FWSLog.

domain

Should be set when calling new() and can be accessed via $fws->{domain};

encryptionKey

Should be set when calling new() and can be accessed via $fws->{encryptionKey};

encryptionType

Should be set when calling new() and can be accessed via $fws->{encryptionType};

fileDir

Should be set when calling new() and can be accessed via $fws->{fileDir};

filePackagePath

Deprecated. This is set during siteSiteValues().Should be set when calling new() and can be accessed via $fws->{fileFWSPath};

filePath

Should be set when calling new() and can be accessed via $fws->{filePath};

fileSecurePath

Should be set when calling new() and can be accessed via $fws->{fileSecurePath};

fileStagingPath

Deprecated, V2 does not have built in staging control. Staging is handled by an external methodology.

fileWebPath

Should be set when calling new() and can be accessed via $fws->{fileWebPath};

fileWebStagingPath

Deprecated, V2 does not have built in staging control. Staging is handled by an external methodology.

gatewayType

Is set with the administration and normally not accessed outside of the core. Can be accessed via $fws->{gatewayType};

gatewayUserID

Is set with the administration and normally not accessed outside of the core. Can be accessed via $fws->{gatewayUserId};

googleAppsKeyFile

Should be set when calling new() and can be accessed via $fws->{googleAppsKeyFile};

getPageGUID

This is depricated. To get this value you can retrieve it from the dataHash or dataArray under the pageGUID key.

Deprecated, use navigationLink() and add hrefOnly flag.

newDBCheck

Renamed to createFWSDatabase().

phone

Deprecated, use formatPhone()

processDownloads

Deprecated, all downloads are handled by the rendering element.

siteGlobalValue

Deprecated, use siteValue()

skipIpCheckOnLogin

Deprecated, session management was updated to improve ip checking to make this no longer required.

dateTime

Deprecated, use formatDate()

showDateTime

Deprecated, use formatDate()

tinyMCEHead

Deprecated, built into the fws-2.x.css

truncatePhrase

Deprecated, use truncateContent()

pageIdOfElement

Method name changed, use $fws->getPageGUID('theguid')

getFormValues {

Renamed to setFormValues()

getPluginVersion

Single extraction of version replaced by pluginInfo()

guidKey

Deprecated, no longer needed with V2 security models

initActions

Deprecated, no longer needed with V2 work flow models

isStaging

Deprecated.

openRS

Depricated, use runSQL instead.

postHTTP

Depricated, use HTTPRequest instead.

resizeImage

Depricated, use saveImage instead.

runSiteActions

Depricated, all site actions are in plugins or elements

scriptName

Should be set when calling new() and can be accessed via $fws->{scriptName};

secureDomain

Should be set when calling new() and can be accessed via $fws->{secureDomain};

securePageHash

Depricated. All secure page references are done manually for performance and unique logic restrictions.

sendMailBin

Should be set when calling new() and can be accessed via $fws->{sendmailBin};

sendMethod

Should be set when calling new() and can be accessed via $fws->{sendMethod};

siteGUID

Used to retreive the current site GUID. Can be accessed via $fws->{siteGUID};

siteId

Used to retreive the current site Id. Can be accessed via $fws->{siteId};

siteName

Used to retreive the current site GUID. Can be accessed via $fws->{siteName};

tinyMCEEnable

Should be set when calling new() and can be accessed via $fws->{tinyMCEEnable};

queryHead

Should be set when calling new() and can be accessed via $fws->{queryHead};

userLoginId

Should NEVER be set manually, it will be set during processLogin(). Will return the current site user logged in. If it is blank then no site user is logged in and can be accessed via $fws->{userLoginId};

DBHost

Should be set when calling new() and can be accessed via $fws->{DBHost};

DBName

Should be set when calling new() and can be accessed via $fws->{DBName};

DBPassword

Should be set when calling new() and can be accessed via $fws->{DBPassword};

DBType

Should be set when calling new() and can be accessed via $fws->{DBType};

DBUser

Should be set when calling new() and can be accessed via $fws->{DBUser};

FWSLogLevel

Should be set when calling new() and can be accessed via $fws->{FWSLogLevel};

SQLLogLevel

Should be set when calling new() and can be accessed via $fws->{SQLLogLevel};

XMLNode

Node safe routine for XML replaced by safeXML

CSVNode

Node safe routine for XML replaced by safeCSV

AUTHOR

Nate Lewis, <nlewis at gnetworks.com>

BUGS

Please report any bugs or feature requests to bug-fws-v2 at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=FWS-V2. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc FWS::V2::Legacy

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2013 Nate Lewis.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.