id: 68
name: GoodNewsGetNewsletters
description: 'Snippet to get a list of newsletters of the actual or specified container.'
category: GoodNews
properties: 'a:11:{s:6:"parent";a:7:{s:4:"name";s:6:"parent";s:4:"desc";s:39:"prop_goodnewsgetnewsletters.parent_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:3:"tpl";a:7:{s:4:"name";s:3:"tpl";s:4:"desc";s:36:"prop_goodnewsgetnewsletters.tpl_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:6:"sortby";a:7:{s:4:"name";s:6:"sortby";s:4:"desc";s:39:"prop_goodnewsgetnewsletters.sortby_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:11:"publishedon";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:7:"sortdir";a:7:{s:4:"name";s:7:"sortdir";s:4:"desc";s:40:"prop_goodnewsgetnewsletters.sortdir_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:4:"DESC";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:14:"includeContent";a:7:{s:4:"name";s:14:"includeContent";s:4:"desc";s:47:"prop_goodnewsgetnewsletters.includecontent_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:5:"limit";a:7:{s:4:"name";s:5:"limit";s:4:"desc";s:38:"prop_goodnewsgetnewsletters.limit_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:1:"0";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:6:"offset";a:7:{s:4:"name";s:6:"offset";s:4:"desc";s:39:"prop_goodnewsgetnewsletters.offset_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:1:"0";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:8:"totalVar";a:7:{s:4:"name";s:8:"totalVar";s:4:"desc";s:41:"prop_goodnewsgetnewsletters.totalvar_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:5:"total";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:15:"outputSeparator";a:7:{s:4:"name";s:15:"outputSeparator";s:4:"desc";s:48:"prop_goodnewsgetnewsletters.outputseparator_desc";s:4:"type";s:9:"textfield";s:7:"options";s:0:"";s:5:"value";s:2:"\n";s:7:"lexicon";s:19:"goodnews:properties";s:4:"area";s:0:"";}s:13:"toPlaceholder";a:7:{s:4:"name";s:13:"toPlaceholder";s:4:"desc";s:46:"prop_goodnewsgetnewsletters.toplaceholder_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:5:"debug";a:7:{s:4:"name";s:5:"debug";s:4:"desc";s:38:"prop_goodnewsgetnewsletters.debug_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:"";}}'

-----

/**
 * GoodNews
 *
 * Copyright 2012 by bitego <office@bitego.com>
 *
 * 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 to get a list of newsletters of the actual or specified container.
 *
 * @var modX $modx
 *
 * @package goodnews
 */

$corePath = $modx->getOption('goodnews.core_path', null, $modx->getOption('core_path').'components/goodnews/');
$goodnews = $modx->getService('goodnews','GoodNews', $corePath.'model/goodnews/', $scriptProperties);
if (!($goodnews instanceof GoodNews)) return '';

$output = array();

// Default properties
$parent          = !empty($parent) ? $parent : $modx->resource->get('id');
$tpl             = !empty($tpl) ? $tpl : 'sample.GoodNewsNewsletterRowTpl';
$sortby          = isset($sortby) ? $sortby : 'publishedon';
$sortdir         = isset($sortdir) ? $sortdir : 'DESC';
$includeContent  = !empty($includeContent) ? true : false;
$limit           = isset($limit) ? (integer)$limit : 10;
$offset          = isset($offset) ? (integer)$offset : 0;
$totalVar        = !empty($totalVar) ? $totalVar : 'total';
$outputSeparator = isset($outputSeparator) ? $outputSeparator : "\n";
$toPlaceholder   = !empty($toPlaceholder) ? $toPlaceholder : '';
$debug           = !empty($debug) ? true : false;

// Check for valid parent
$parent = (integer)$parent;
if (!$goodnews->isGoodNewsContainer($parent)) {
    $modx->log(modX::LOG_LEVEL_INFO, '[GoodNews] GoodNewsGetNewsletters - The provided container [id: '.$parent.'] is not a valid GoodNews container.');
    return '';
}

// Query db
$query = $modx->newQuery('modResource');
$resourceColumns = array('id','pagetitle','introtext','createdon','publishedon','content');
if (!$includeContent) { $resourceColumns = array_diff($resourceColumns, array('content')); }
$query->select($modx->getSelectColumns('modResource', 'modResource', '', $resourceColumns));

$query->leftJoin('GoodNewsMailingMeta', 'MailingMeta', 'MailingMeta.mailing_id = modResource.id');
$metaColumns = array('id','senton','sentby','finishedon');
$query->select($modx->getSelectColumns('GoodNewsMailingMeta', 'MailingMeta', 'meta_', $metaColumns));

$query->leftJoin('modUser', 'SentBy', 'SentBy.id = MailingMeta.sentby');
$userColumns = array('id','username');
$query->select($modx->getSelectColumns('modUser', 'SentBy', 'sentby_', $userColumns));

$query->where(array(
    'modResource.class_key' => 'GoodNewsResourceMailing',
    'modResource.parent' => $parent,
    'modResource.published' => 1,
    'modResource.deleted' => 0,
    'MailingMeta.finishedon:>' => 0,
));

$total = $modx->getCount('modResource', $query);
$modx->setPlaceholder($totalVar, $total);

if (!empty($sortby)) {
    $sorts = array($sortby => $sortdir);
    if (is_array($sorts)) {
        while (list($sort, $dir) = each($sorts)) {
            $query->sortby($sort, $dir);
        }
    }
}
if (!empty($limit)) {
    $query->limit($limit, $offset);
}
if ($debug) {
    $query->prepare();
    $modx->log(modX::LOG_LEVEL_ERROR, $query->toSQL());
}

$collection = $modx->getCollection('modResource', $query);

foreach ($collection as $mailingId => $mailing) {

    $properties = array_merge(
        $scriptProperties,
        $mailing->get($resourceColumns),
        $mailing->get(array('meta_senton','meta_finishedon')),
        $mailing->get(array('sentby_username')),
        array('url' => $modx->makeUrl($mailing->get('id'), '', '', $modx->getOption('link_tag_scheme')))
    );
    
    $resourceTpl = '';
    if (!empty($tpl)) {
        $resourceTpl = $goodnews->parseTpl($tpl, $properties);
    }
    
    if (empty($resourceTpl)) {
        $chunk = $modx->newObject('modChunk');
        $chunk->setCacheable(false);
        $output[] = $chunk->process(array(), '<pre>'.print_r($properties, true).'</pre>');
    } else {
        $output[] = $resourceTpl;
    }

}

$output = implode($outputSeparator, $output);

$toPlaceholder = $modx->getOption('toPlaceholder', $scriptProperties, false);
if (!empty($toPlaceholder)) {
    $modx->setPlaceholder($toPlaceholder, $output);
    return '';
}
return $output;