id: 64
name: GoodNewsSubscription
description: 'Handles GoodNews subscription forms in the front-end.'
category: GoodNews
properties: 'a:51:{s:10:"activation";a:7:{s:4:"name";s:10:"activation";s:4:"desc";s:41:"prop_goodnewssubscription.activation_desc";s:4:"type";s:13:"combo-boolean";s:7:"options";s:0:"";s:5:"value";b:1;s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:13:"activationttl";a:7:{s:4:"name";s:13:"activationttl";s:4:"desc";s:44:"prop_goodnewssubscription.activationttl_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";i:180;s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:15:"activationEmail";a:7:{s:4:"name";s:15:"activationEmail";s:4:"desc";s:46:"prop_goodnewssubscription.activationemail_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:22:"activationEmailSubject";a:7:{s:4:"name";s:22:"activationEmailSubject";s:4:"desc";s:53:"prop_goodnewssubscription.activationemailsubject_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:18:"activationEmailTpl";a:7:{s:4:"name";s:18:"activationEmailTpl";s:4:"desc";s:49:"prop_goodnewssubscription.activationemailtpl_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:33:"sample.GoodNewsActivationEmailTpl";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:21:"activationEmailTplAlt";a:7:{s:4:"name";s:21:"activationEmailTplAlt";s:4:"desc";s:52:"prop_goodnewssubscription.activationemailtplalt_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:22:"activationEmailTplType";a:7:{s:4:"name";s:22:"activationEmailTplType";s:4:"desc";s:53:"prop_goodnewssubscription.activationemailtpltype_desc";s:4:"type";s:4:"list";s:7:"options";a:4:{i:0;a:2:{s:5:"value";s:8:"modChunk";s:4:"text";s:18:"opt_goodnews.chunk";}i:1;a:2:{s:5:"value";s:4:"file";s:4:"text";s:17:"opt_goodnews.file";}i:2;a:2:{s:5:"value";s:6:"inline";s:4:"text";s:19:"opt_goodnews.inline";}i:3;a:2:{s:5:"value";s:8:"embedded";s:4:"text";s:21:"opt_goodnews.embedded";}}s:5:"value";s:8:"modChunk";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:20:"activationResourceId";a:7:{s:4:"name";s:20:"activationResourceId";s:4:"desc";s:51:"prop_goodnewssubscription.activationresourceid_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:19:"submittedResourceId";a:7:{s:4:"name";s:19:"submittedResourceId";s:4:"desc";s:50:"prop_goodnewssubscription.submittedresourceid_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:21:"sendSubscriptionEmail";a:7:{s:4:"name";s:21:"sendSubscriptionEmail";s:4:"desc";s:52:"prop_goodnewssubscription.sendsubscriptionemail_desc";s:4:"type";s:13:"combo-boolean";s:7:"options";s:0:"";s:5:"value";b:0;s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:21:"unsubscribeResourceId";a:7:{s:4:"name";s:21:"unsubscribeResourceId";s:4:"desc";s:52:"prop_goodnewssubscription.unsubscriberesourceid_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:17:"profileResourceId";a:7:{s:4:"name";s:17:"profileResourceId";s:4:"desc";s:48:"prop_goodnewssubscription.profileresourceid_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:24:"subscriptionEmailSubject";a:7:{s:4:"name";s:24:"subscriptionEmailSubject";s:4:"desc";s:55:"prop_goodnewssubscription.subscriptionemailsubject_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:20:"subscriptionEmailTpl";a:7:{s:4:"name";s:20:"subscriptionEmailTpl";s:4:"desc";s:51:"prop_goodnewssubscription.subscriptionemailtpl_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:35:"sample.GoodNewsSubscriptionEmailTpl";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:23:"subscriptionEmailTplAlt";a:7:{s:4:"name";s:23:"subscriptionEmailTplAlt";s:4:"desc";s:54:"prop_goodnewssubscription.subscriptionemailtplalt_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:24:"subscriptionEmailTplType";a:7:{s:4:"name";s:24:"subscriptionEmailTplType";s:4:"desc";s:55:"prop_goodnewssubscription.subscriptionemailtpltype_desc";s:4:"type";s:4:"list";s:7:"options";a:4:{i:0;a:2:{s:5:"value";s:8:"modChunk";s:4:"text";s:18:"opt_goodnews.chunk";}i:1;a:2:{s:5:"value";s:4:"file";s:4:"text";s:17:"opt_goodnews.file";}i:2;a:2:{s:5:"value";s:6:"inline";s:4:"text";s:19:"opt_goodnews.inline";}i:3;a:2:{s:5:"value";s:8:"embedded";s:4:"text";s:21:"opt_goodnews.embedded";}}s:5:"value";s:8:"modChunk";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:26:"reSubscriptionEmailSubject";a:7:{s:4:"name";s:26:"reSubscriptionEmailSubject";s:4:"desc";s:57:"prop_goodnewssubscription.resubscriptionemailsubject_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:22:"reSubscriptionEmailTpl";a:7:{s:4:"name";s:22:"reSubscriptionEmailTpl";s:4:"desc";s:53:"prop_goodnewssubscription.resubscriptionemailtpl_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:35:"sample.GoodNewsSubscriptionEmailTpl";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:25:"reSubscriptionEmailTplAlt";a:7:{s:4:"name";s:25:"reSubscriptionEmailTplAlt";s:4:"desc";s:56:"prop_goodnewssubscription.resubscriptionemailtplalt_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:26:"reSubscriptionEmailTplType";a:7:{s:4:"name";s:26:"reSubscriptionEmailTplType";s:4:"desc";s:57:"prop_goodnewssubscription.resubscriptionemailtpltype_desc";s:4:"type";s:4:"list";s:7:"options";a:4:{i:0;a:2:{s:5:"value";s:8:"modChunk";s:4:"text";s:18:"opt_goodnews.chunk";}i:1;a:2:{s:5:"value";s:4:"file";s:4:"text";s:17:"opt_goodnews.file";}i:2;a:2:{s:5:"value";s:6:"inline";s:4:"text";s:19:"opt_goodnews.inline";}i:3;a:2:{s:5:"value";s:8:"embedded";s:4:"text";s:21:"opt_goodnews.embedded";}}s:5:"value";s:8:"modChunk";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:6:"errTpl";a:7:{s:4:"name";s:6:"errTpl";s:4:"desc";s:37:"prop_goodnewssubscription.errtpl_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:37:"<span class="error">[[+error]]</span>";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:11:"useExtended";a:7:{s:4:"name";s:11:"useExtended";s:4:"desc";s:42:"prop_goodnewssubscription.useextended_desc";s:4:"type";s:13:"combo-boolean";s:7:"options";s:0:"";s:5:"value";b:0;s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:15:"excludeExtended";a:7:{s:4:"name";s:15:"excludeExtended";s:4:"desc";s:46:"prop_goodnewssubscription.excludeextended_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:10:"emailField";a:7:{s:4:"name";s:10:"emailField";s:4:"desc";s:41:"prop_goodnewssubscription.emailfield_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:5:"email";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:13:"usernameField";a:7:{s:4:"name";s:13:"usernameField";s:4:"desc";s:44:"prop_goodnewssubscription.usernamefield_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:8:"username";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:13:"passwordField";a:7:{s:4:"name";s:13:"passwordField";s:4:"desc";s:44:"prop_goodnewssubscription.passwordfield_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:8:"password";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:13:"persistParams";a:7:{s:4:"name";s:13:"persistParams";s:4:"desc";s:44:"prop_goodnewssubscription.persistparams_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:8:"preHooks";a:7:{s:4:"name";s:8:"preHooks";s:4:"desc";s:39:"prop_goodnewssubscription.prehooks_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:9:"postHooks";a:7:{s:4:"name";s:9:"postHooks";s:4:"desc";s:40:"prop_goodnewssubscription.posthooks_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:12:"redirectBack";a:7:{s:4:"name";s:12:"redirectBack";s:4:"desc";s:43:"prop_goodnewssubscription.redirectback_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:18:"redirectBackParams";a:7:{s:4:"name";s:18:"redirectBackParams";s:4:"desc";s:49:"prop_goodnewssubscription.redirectbackparams_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:9:"submitVar";a:7:{s:4:"name";s:9:"submitVar";s:4:"desc";s:40:"prop_goodnewssubscription.submitvar_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:25:"goodnews-subscription-btn";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:10:"successMsg";a:7:{s:4:"name";s:10:"successMsg";s:4:"desc";s:41:"prop_goodnewssubscription.successmsg_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:10:"usergroups";a:7:{s:4:"name";s:10:"usergroups";s:4:"desc";s:41:"prop_goodnewssubscription.usergroups_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:15:"usergroupsField";a:7:{s:4:"name";s:15:"usergroupsField";s:4:"desc";s:46:"prop_goodnewssubscription.usergroupsfield_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:8:"validate";a:7:{s:4:"name";s:8:"validate";s:4:"desc";s:39:"prop_goodnewssubscription.validate_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:14:"grpFieldsetTpl";a:7:{s:4:"name";s:14:"grpFieldsetTpl";s:4:"desc";s:45:"prop_goodnewssubscription.grpfieldsettpl_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:29:"sample.GoodNewsGrpFieldsetTpl";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:10:"grpNameTpl";a:7:{s:4:"name";s:10:"grpNameTpl";s:4:"desc";s:41:"prop_goodnewssubscription.grpnametpl_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:25:"sample.GoodNewsGrpNameTpl";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:11:"grpFieldTpl";a:7:{s:4:"name";s:11:"grpFieldTpl";s:4:"desc";s:42:"prop_goodnewssubscription.grpfieldtpl_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:26:"sample.GoodNewsGrpFieldTpl";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:17:"grpFieldHiddenTpl";a:7:{s:4:"name";s:17:"grpFieldHiddenTpl";s:4:"desc";s:48:"prop_goodnewssubscription.grpfieldhiddentpl_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:32:"sample.GoodNewsGrpFieldHiddenTpl";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:11:"catFieldTpl";a:7:{s:4:"name";s:11:"catFieldTpl";s:4:"desc";s:42:"prop_goodnewssubscription.catfieldtpl_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:26:"sample.GoodNewsCatFieldTpl";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:17:"catFieldHiddenTpl";a:7:{s:4:"name";s:17:"catFieldHiddenTpl";s:4:"desc";s:48:"prop_goodnewssubscription.catfieldhiddentpl_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:32:"sample.GoodNewsCatFieldHiddenTpl";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:10:"groupsOnly";a:7:{s:4:"name";s:10:"groupsOnly";s:4:"desc";s:41:"prop_goodnewssubscription.groupsonly_desc";s:4:"type";s:13:"combo-boolean";s:7:"options";s:0:"";s:5:"value";b:0;s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:13:"includeGroups";a:7:{s:4:"name";s:13:"includeGroups";s:4:"desc";s:44:"prop_goodnewssubscription.includegroups_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:13:"defaultGroups";a:7:{s:4:"name";s:13:"defaultGroups";s:4:"desc";s:44:"prop_goodnewssubscription.defaultgroups_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:17:"defaultCategories";a:7:{s:4:"name";s:17:"defaultCategories";s:4:"desc";s:48:"prop_goodnewssubscription.defaultcategories_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:4:"sort";a:7:{s:4:"name";s:4:"sort";s:4:"desc";s:35:"prop_goodnewssubscription.sort_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:4:"name";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:3:"dir";a:7:{s:4:"name";s:3:"dir";s:4:"desc";s:34:"prop_goodnewssubscription.dir_desc";s:4:"type";s:4:"list";s:7:"options";a:2:{i:0;a:2:{s:5:"value";s:3:"ASC";s:4:"text";s:16:"opt_goodnews.asc";}i:1;a:2:{s:5:"value";s:4:"DESC";s:4:"text";s:17:"opt_goodnews.desc";}}s:5:"value";s:3:"ASC";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:17:"grpCatPlaceholder";a:7:{s:4:"name";s:17:"grpCatPlaceholder";s:4:"desc";s:48:"prop_goodnewssubscription.grpcatplaceholder_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:15:"grpcatfieldsets";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:17:"placeholderPrefix";a:7:{s:4:"name";s:17:"placeholderPrefix";s:4:"desc";s:48:"prop_goodnewssubscription.placeholderprefix_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:9:"errorPage";a:7:{s:4:"name";s:9:"errorPage";s:4:"desc";s:40:"prop_goodnewssubscription.errorpage_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:0:"";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}}'

-----

/**
 * GoodNews
 *
 * Copyright 2012 by bitego <office@bitego.com>
 * Based on code from Login add-on
 * Copyright 2010 by Shaun McCormick <shaun@modx.com>
 * Modified by bitego - 10/2013
 *
 * GoodNews is free software; you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later
 * version.
 *
 * GoodNews is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this software; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA 02111-1307 USA
 */

/**
 * Snippet which handles new subscriptions and processes subscription forms.
 *
 * @var modX $modx
 * @var GoodNewsSubscription $goodnewssubscription
 * @var array $scriptProperties
 *
 * @property boolean $activation Whether or not to require activation for subscription. (default: 1=true)
 * @property string $activationttl Number of minutes until the activation email expires. (default: 3 hours)
 * @property string $activationEmail Send either to user's email address or this specified activation email address. (default: '' = users email)
 * @property string $activationEmailSubject The subject of the activation email. (default: a lexicon string)
 * @property string $activationEmailTpl The template for the activation email. (default: sample.GoodNewsActivationEmailTpl)
 * @property string $activationEmailTplAlt If set, will use this template instead of $activationEmailTpl (e.g. for plaintext mails). (default: '')
 * @property string $activationEmailTplType The type of tpl provided for the activation email. (default: modChunk)
 * @property string $activationResourceId The Resource ID where the GoodNewsConfirmSubscription snippet is located. (default: '')
 * @property string $submittedResourceId If set, will redirect to the specified resource after the user submits the subscription form. (default: '')
 * @property string $unsubscribeResourceId The ID of the resource for one-click unsubscription. (default: '')
 * @property string $profileResourceId The ID of the resource for editing the mailing profile. (default: '')
 * @property boolean $sendSubscriptionEmail Wether or not to send user an email after successful subscription.
 * @property string $subscriptionEmailSubject The subject of the subscription email. (default: a lexicon string)
 * @property string $subscriptionEmailTpl The template for the subscription email. (default: sample.GoodNewsSubscriptionEmailTpl)
 * @property string $subscriptionEmailTplAlt If set, will use this template instead of $subscriptionEmailTpl (e.g. for plaintext mails). (default: '')
 * @property string $subscriptionEmailTplType The type of tpl provided for the subscription email. (default: modChunk)
 * @property string $reSubscriptionEmailSubject The subject of the renewal email. (default: a lexicon string)
 * @property string $reSubscriptionEmailTpl The template for the renewal email. (default: sample.GoodNewsReSubscriptionEmailTpl)
 * @property string $reSubscriptionEmailTplAlt If set, will use this template instead of $reSubscriptionEmailTpl (e.g. for plaintext mails). (default: '')
 * @property string $reSubscriptionEmailTplType The type of tpl provided for the renewal email. (default: modChunk)
 * @property string $errTpl Chunk for error output. (default: <span class="error">[[+error]]</span>)
 * @property boolean $useExtended Whether or not to set any extra fields in the form to the users extended field. (default: 0 = false)
 * @property string $excludeExtended A comma-separated list of fields to exclude from setting as extended fields. (default: '')
 * @property string $emailField The name of the field to use for the new User's email address. (default: email)
 * @property string $usernameField The name of the field to use for the new User's username. (default: username)
 * @property string $passwordField The name of the field to use for the new User's password. (default: password)
 * @property string $persistParams A JSON object of parameters to persist across the register process. (default: '')
 * @property string $preHooks A comma-separated list of 'hooks' (snippets), that will be executed before the user is subscribed but after validation. (default: '')
 * @property string $postHooks A comma-separated list of 'hooks' (snippets), that will be executed after the user is subscribed. (default: '')
 * @property string $redirectBack (default: '')
 * @property string $redirectBackParams (default: '')
 * @property string $submitVar The name of the form submit button that triggers the submission. (default: goodnews-subscription-btn)
 * @property string $successMsg If page redirects to itself, this message will be set to a placeholder.
 * @property string $usergroups A comma-separated list of MODX user group names or IDs to add the new subscriber to. (default: '')
 * @property string $usergroupsField The name of the field to use for the new subscribers usergroups. (default: 'usergroups')
 * @property string $validate A comma-separated list of fields to validate. (default: '')
 * @property string $grpFieldsetTpl Chunk name for group fieldset. (default: sample.GoodNewsGrpFieldsetTpl)
 * @property string $grpFieldTpl Chunk name for group checkbox element. (default: sample.GoodNewsGrpFieldTpl)
 * @property string $grpNameTpl Chunk name for group name element. (default: sample.GoodNewsGrpNameTpl)
 * @property string $grpFieldHiddenTpl Chunk name for group input hidden element. (default: sample.GoodNewsGrpFieldHiddenTpl)
 * @property string $catFieldTpl Chunk name for category checkbox element. (default: sample.GoodNewsCatFieldTpl)
 * @property string $catFieldHiddenTpl Chunk name for category input hidden element. (default: sample.GoodNewsCatFieldHiddenTpl)
 * @property boolean $groupsOnly Whether or not the output should only contain groups. (default: 0 = false)
 * @property string $includeGroups Comma separated list of group ids to be used for output. (default: 0 = use all groups)
 * @property string $defaultGroups Comma separated list of group ids which should be preselected as hidden fields. (default: 0 = none)
 * @property string $defaultCategories Comma separated list of category ids which should be preselected as hidden fields. (default: 0 = none)
 * @property string $sort Field to sort by for groups/categories. (default: name)
 * @property string $dir Sort direction for groups/categories. (default: ASC)
 * @property string $grpCatPlaceholder The placeholder to set the generated groups/categories tree to. (default: grpcatfieldsets)
 * @property string $placeholderPrefix The prefix to use for all placeholders set by this snippet. (default: '')
 * @package goodnews
 */

require_once $modx->getOption('goodnews.core_path', null, $modx->getOption('core_path').'components/goodnews/').'model/goodnews/goodnewssubscription.class.php';
$goodnewssubscription = new GoodNewsSubscription($modx, $scriptProperties);

$controller = $goodnewssubscription->loadController('Subscription');
$output = $controller->run($scriptProperties);
return $output;