]*?>.*?@siU', // Strip style tags properly
'@<[\/\!]*?[^<>]*?>@si', // Strip out HTML tags
'@@' // Strip multi-line comments including CDATA
);
if ($mode == 'html') {$strip_out = preg_replace($htmlexpressions, '', $content);}
elseif ($mode == 'smarty') {$strip_out = preg_replace('/\{.*?\}/', '', $content);}
return $strip_out;
}
/*
Main Plug-in Action
====================================================================================================
This is the real deal
*/
function smarty_cms_function_content_dump($params, &$smarty) {
/*
Parameter Handling
====================================================================================================
Assign all parameters to internally used variables. By doing so, check for existance and assign default values if not
specified. Some of the main sql query string is assembled here.
*/
/* Check if output should be assigned to a specific variable name */
if (isset($params['assign'])) {
$assign = trim($params['assign']);
} else {
$assign = 'dump';
}
/* Check if parent page data should be included in results entries */
if (isset($params['parents']) AND ($params['parents'] == true)) {
$parents = true;
} else {
$parents = false;
}
/* Check if user data should be looked up for each entry */
if (isset($params['users']) AND ($params['users'] == true)) {
$users = true;
} else {
$users = false;
}
/* Set locale if required (e.g. dates/times). Locale is reset to default after script completed */
if (isset($params['cdlocale']) AND ($params['cdlocale'] == true)) {
setlocale(LC_TIME,$params['cdlocale']);
} else {
setlocale(LC_TIME,'');
}
/* Check for which content block to pick - if not set, pick default "contetn_en" */
if (isset($params['block_name'])) {$block = $params['block_name'];}
else {$block = 'content_en';}
$sql_content_query_having = " HAVING prop_name='".$block."' "."\n";
/* Set a date format for your Content entries */
if (isset($params['dateformat'])) {$dateformat = $params['dateformat'];}
else {$dateformat = '%A, %e %B %Y';}
/* Check if start id is set, if so, tag will ony return pages that have this id or are located below */
if (isset($params['start_id'])) {
$sql_content_query_limit_sitearea = " AND id_hierarchy REGEXP '".$params['start_id']."' ";
$start_id = (integer)$params['start_id'];
} else {
$sql_content_query_limit_sitearea = '';
$start_id = -1;
}
/* Check if parent page data should be included in results entries */
if (isset($params['depth'])) {
$depth = explode(",",$params['depth']);
/* Define the starting hierarchy */
if ($depth[0] == -1) {
$start_depth = serve_current_level($start_id);
} elseif((integer)$depth[0] == 0) {
$start_depth = 1;
} else {
$start_depth = (integer)$depth[0];
}
/* These are the REGEXP snippets used */
$snip1 = "'^[0-9]{1,10}";
$snip2 = "\.[0-9]{1,10}";
/* Create Query String for first hierarchy level */
if ($start_depth >= 1){
$buffer1 = $snip1;
for ($i=1; $i<=$start_depth-1; $i++) {
$buffer1 = $buffer1."".$snip2;
}
}
$sql_content_query_limit_hierarchy = " AND (id_hierarchy REGEXP ".$buffer1."$' \n";
/* Create Query String for remaining hierarchy levels */
$max_depth = $start_depth+(integer)$depth[1];
for ($i=$start_depth; $i<=$max_depth-1; $i++) {
$buffer2 = $buffer1;
$distance = $i-$start_depth;
for ($j=0; $j<=$distance; $j++) {
$buffer2 = $buffer2.''.$snip2 ;
}
$sql_content_query_limit_hierarchy .= " OR id_hierarchy REGEXP ".$buffer2."$' \n";
}
$sql_content_query_limit_hierarchy = $sql_content_query_limit_hierarchy.")";
} else {$sql_content_query_limit_hierarchy = '';}
/* Check if first sorting item-sort-order is set - otherwise set to default , which is upwards */
if (isset($params['first_sort_order'])) {$first_sort_order = $params['first_sort_order'];}
else {$first_sort_order = 'up';}
/* Check if second sorting item-sort-order is set - otherwise set to default , which is upwards */
if (isset($params['second_sort_order'])) {$second_sort_order = $params['second_sort_order'];}
else {$second_sort_order = 'up';}
/* Check for first sort parameter, if not set, first sort parameter will be the hierarchy date of the page */
if (isset($params['first_sort'])) {$sql_content_query_first_sort = sql_sort_param($params['first_sort'],0,$first_sort_order);}
else {$sql_content_query_first_sort = sql_sort_param('hierarchy',0,'up');}
/* Check for second sort parameter, if not set, second sort parameter will be the creation date of the page */
if (isset($params['second_sort'])) {$sql_content_query_second_sort = sql_sort_param($params['second_sort'],2,$second_sort_order);}
else {$sql_content_query_second_sort = '';}
/* Check for parameter exclude, if it contains ID(s) seperated by comma, it will create an array of IDs we can exclude later on */
$sql_content_query_excludes = '';
if (isset($params['exclude'])) {
$exclude_ids = explode(",", $params['exclude']);
for ($i=0; $i<=count($exclude_ids)-1; $i++) {
$sql_content_query_excludes .= "AND ".cms_db_prefix()."content.content_id != ".$exclude_ids[$i]." \n";
}
} else {
$exclude_ids[0] = -1;
$sql_content_query_excludes = '';
}
/* Limit the query results to a singe content_id by adding a condition to the query statement - if not set, do not add anything to the query string */
if (isset($params['this_only'])) {$sql_content_query_this_only = "AND ".cms_db_prefix()."content.content_id = ".$params['this_only'];}
else {$sql_content_query_this_only = '';}
/* Check for parameter exclude, if it contains ID(s) seperated by comma, it will create an array of IDs we can exclude later on */
if (isset($params['these_only'])) {
$include_ids = explode(",", $params['these_only']);
$sql_content_query_includes = '(';
for ($i=0; $i<=count($include_ids)-1; $i++) {
$sql_content_filter .= "OR ".cms_db_prefix()."content.content_id != ".$include_ids[$i]." \n";
}
$sql_content_filter = $sql_content_filter.")";
} else {
$include_ids[0] = -1;
$sql_content_filter = '';
}
/* If set to compile, smarty tags in the content will be compiled - set to false per default !WARNING! MAY CAUSE RECURSION AND ULTIMATELY OUT OF MEMORY ERROR */
if (isset($params['do_smarty'])) {
switch($params['do_smarty']){
case 'neutral': $c_smarty = 'neutral' ; break;
case 'compile': $c_smarty = 'compile'; break;
case 'strip': $c_smarty = 'strip'; break;
default: $c_smarty = 'neutral'; break;
}
} else {$c_smarty = 'neutral';}
/* If set to strip, HTML tags in the content will be removed (inluding JS, CSS and HTML) */
if (isset($params['html']) AND ($params['html'] == 'strip')) {$c_html = 'strip';
} else {$c_html = 'neutral';}
/* Check and set how the "active" page flag is handled */
if (isset($params['active'])) {
switch($params['active']){
case force: $sql_content_query_active = ' ' ; break;
case active: $sql_content_query_active = ' AND active = 1 '."\n"; break;
case inactive: $sql_content_query_active = ' AND active = 0 '."\n"; break;
default: $sql_content_query_active = ' AND active = 1 '."\n"; break;
}
} else {$sql_content_query_active = ' AND active = 1 '."\n";}
/* Check and set how the "show_in_menu" page flag is handled */
if (isset($params['show_in_menu'])) {
switch($params['show_in_menu']){
case force: $sql_content_query_show = ' ' ; break;
case show: $sql_content_query_show = ' AND show_in_menu = 1 '."\n" ; break;
case hidden: $sql_content_query_show = 'AND show_in_menu = 0 '."\n" ; break;
default: $sql_content_query_show = ' AND show_in_menu = 1 '."\n"; break;
}
} else {$sql_content_query_show = ' AND show_in_menu = 1 '."\n";}
/* Set the first item to show, if not set, it will begin with the first item shown */
if (isset($params['limit_start'])) {
$limit_start = $params['limit_start'];
$limit_start_orig = $params['limit_start'];
} else {
$limit_start = 0;
$limit_start_orig = 0;
}
/* Set the number of items to show, if no parameter is set, limit to 1000 results */
if (isset($params['limit_count'])) {
$limit_count = $params['limit_count'];
$limit_count_orig = $params['limit_count'];
} else {
$limit_count = 1000;
$limit_count_orig = 1000;
}
/* if parameter extension is used, explode prop_names and store in an array */
if (isset($params['extensions'])) {
$extensions = array ();
$extensions = explode(",", $params['extensions']);
$count_extensions = count($extensions);
$sql_content_query_props = '';
for ($i=0; $i<=$count_extensions-1; $i++){
$sql_content_query_props .= " OR prop_name='".$extensions[$i]."' "."\n";
}
$limit_count = $limit_count*($count_extensions+1);
if ($limit_start >= 1 ){$limit_start = ($limit_start*($count_extensions+1))-1;}
$extension = true;
} else {$sql_content_query_props = '';$extension = false;}
/* Check how a stated prefix should be handled */
if (isset($params['prefix_mode'])) {$prefix_mode = $params['prefix_mode'];}
else {$prefix_mode = 'neutral';$sql_prefix_filter = '';}
/* Check what prefixes should be handled */
if (isset($params['prefix'])) {
$prefixs = explode(",", $params['prefix']);
$count = count($prefixs);
if ($prefix_mode == 'force'){$sql_prefix_filter = " AND content_alias REGEXP '^";}
if ($prefix_mode == 'hide'){$sql_prefix_filter = " AND content_alias NOT REGEXP '^";}
if ($prefix_mode != 'neutral'){
if ($count > 1) {$sql_prefix_filter = $sql_prefix_filter.'(';}
for ($i=0; $i<=$count-1; $i++) {
$sql_prefix_filter = $sql_prefix_filter.''.$prefixs[$i];
if ($i < $count-1) {$sql_prefix_filter = $sql_prefix_filter.'|';}
}
if ($count > 1) {
$sql_prefix_filter = $sql_prefix_filter.")'\n";
} else {
$sql_prefix_filter = $sql_prefix_filter."'\n";
}
}
} else {
$sql_prefix_filter = '';
}
/* Check if parameter page specified a page to display, does only make sense when used with limit_count, which is the page size */
if (isset($params['page']) AND ($params['page'] != '')) {
$page_number = $params['page'];
// There is ni negative page or a page numbered zero
if ($page_number <= 0) {$page_number = 1;}
if ($page_number == 1) {
// Page is one, we do not need to change anything
} elseif ($page_number == 2) {
// this is the second page,
if ($limit_start == 0) {$limit_start = $limit_count;}
else {$limit_start = $limit_start + $limit_count-1;}
} elseif ($page_number >=3) {
// and this any following page
if ($limit_start == 0) {$limit_start = $limit_count*($page_number-1);}
else {$limit_start = $limit_start + ($limit_count*($page_number-1))-1;}
}
$pager_info = new StdClass;
$pager_info->current = $page_number;
$pager_info->max = serve_max_page($block,$sql_content_query_limit_hierarchy,$sql_prefix_filter,$sql_content_filter,$limit_count_orig,$limit_start_orig,$exclude_ids,$sql_content_query_limit_sitearea,$sql_content_query_active,$sql_content_query_show);
$pager_info->size = $limit_count_orig;
}
/* If start and count are not set, ignore the output limit and give back everything, else: assemble mysql limit statement */
if(isset($params['limit_start']) OR isset($params['limit_count'])) {
$sql_content_query_limit = ' LIMIT '.$limit_start.' , '.$limit_count;
} else {$sql_content_query_limit = '';}
/* Create FULLTEXT Search expression */
if ((isset($params['filter'])) AND ($params['filter'] != '')) {
$these_ids_array = serve_matching_pages($block,$sql_content_query_limit_hierarchy,$sql_prefix_filter,$params['filter'],$limit_count_orig,$limit_start_orig,$exclude_ids,$sql_content_query_limit_sitearea);
$filter_count = count($these_ids_array);
if ($filter_count > 0) {$sql_content_filter = 'AND (';}
For ($i=0; $i<=$filter_count-1;$i++){
if ($i > 0) {$sql_content_filter .= 'OR ';} else {$sql_content_filter .= ' ';}
$sql_content_filter = $sql_content_filter.''.cms_db_prefix()."content_props.content_id = '".$these_ids_array[$i]."' ";
}
if ($filter_count > 0) {$sql_content_filter .= ") \n";}
if ($filter_count == 0) {
$sql_content_filter = ' AND '.cms_db_prefix()."content_props.content_id = -1 \n";
}
} else {
$sql_content_filter = '';
}
/* Get Global CMS Information */
global $gCms;
/* Get Database Configuration/Connection */
$db = &$gCms->db;
/*
Starting query element for final content query
====================================================================================================
*/
$sql_content_query_start = "
SELECT
".cms_db_prefix()."content.content_id as content_id,
content_name,
show_in_menu,
".cms_db_prefix()."content.create_date,
".cms_db_prefix()."content.modified_date,
owner_id,
id_hierarchy,
parent_id,
last_modified_by,
active,
prop_name,
content,
content_alias
FROM
".cms_db_prefix()."content, ".cms_db_prefix()."content_props
WHERE
".cms_db_prefix()."content.content_id = ".cms_db_prefix()."content_props.content_id
";
/*
Assemble Content Query Link
====================================================================================================
>> Put all mysql query elements into one string
*/
$sql_the_full_query =
$sql_content_query_start.'
'.$sql_content_filter.'
'.$sql_prefix_filter.'
'.$sql_content_query_limit_sitearea.'
'.$sql_content_query_limit_hierarchy.'
'.$sql_content_query_excludes.'
'.$sql_content_query_active.'
'.$sql_content_query_show.'
'.$sql_content_query_this_only.'
'.$sql_content_query_having.'
'.$sql_content_query_props.'
'.$sql_content_query_first_sort.'
'.$sql_content_query_second_sort.'
'.$sql_content_query_limit;
/*
Execute mysql Command
====================================================================================================
*/
$dbresult = $db->Execute( $sql_the_full_query );
if( !$dbresult )
{
echo 'DB error: '. $db->ErrorMsg()."
";
}
/*
Store Database Results in Array of Classes
====================================================================================================
>> Go for each mySQL Query result row and assign each row with its contents to a class called dump_item
*/
/* if we use extension checking... we need an extra array */
if ($extension == true) {
$content_props = array();
$counter = 0;
}
$content_dump = array();
$parent_ids = array();
$user_ids = array();
$dump_count = 0;
while ($dbresult && $dbqueryresultrow = $dbresult->FetchRow())
{
/* Store the data of items with prop_name (=block-name) of parameter "block" into an array - this is our main content_dump item data*/
if ($dbqueryresultrow['prop_name'] == $block) {
$dump_item = new StdClass;
$dump_item->item = $dump_count;
$dump_item->content->id = $dbqueryresultrow['content_id'];
$dump_item->content->alias = $dbqueryresultrow['content_alias'];
$dump_item->content->title = $dbqueryresultrow['content_name'];
$dump_item->content->show = $dbqueryresultrow['show_in_menu'];
$dump_item->content->active = $dbqueryresultrow['active'];
$dump_item->content->data = $dbqueryresultrow['content'];
/* See if the ID of this pages parent is already known as a page for which we need to lookup name and alias later on*/
if ($parents = true) {
$parent_ids = id_array_make($parent_ids,$dbqueryresultrow['parent_id']);
}
$dump_item->parents->id = $dbqueryresultrow['parent_id'];
$dump_item->parents->alias = '';
$dump_item->parents->title = '';
if ($users = true) {
$user_ids = id_array_make($user_ids,$dbqueryresultrow['owner_id']);
$user_ids = id_array_make($user_ids,$dbqueryresultrow['last_modified_by']);
}
$dump_item->created->by = $dbqueryresultrow['owner_id'];
$dump_item->created->date = strftime($dateformat,strtotime($dbqueryresultrow['create_date']));
$dump_item->modified->by = $dbqueryresultrow['last_modified_by'];
$dump_item->modified->date = strftime($dateformat,strtotime($dbqueryresultrow['modified_date']));
$dump_item->extension = 0;
$content_dump[] = $dump_item;
$dump_count = $dump_count+1;
} elseif (($extension == true) AND ($dbqueryresultrow['content'] != '')) {
// If the content block is not our primary content block, let's check if we should assign it to our buffer array, that stores all the other props
$content_props[$counter]['content_id'] = $dbqueryresultrow['content_id'];
$content_props[$counter]['content'] = $dbqueryresultrow['content'];
$content_props[$counter]['prop_name'] = $dbqueryresultrow['prop_name'];
$counter = $counter + 1;
}
}
/*
Get the extra data into the reults (if needed)
====================================================================================================
>> To do so, we look at each result entry and compare it to the single data options (parents, extensions, users as well as strip options)
*/
$count_content_dump = count($content_dump);
if ($parents == true) {
$theparents = array();
$theparents = serve_parent_data($parent_ids);
$count_theparents = count($theparents);
}
if ($users == true) {
$theusers = array();
$theusers = serve_user_data($user_ids);
$count_theusers = count($theusers);
}
if ($extension == true) {
$count_content_props = count($content_props);
}
for ($i=0; $i<=$count_content_dump-1; $i++){
if ($parents == true) {
// Compare against parent IDs to expand parents data
for ($k1=0; $k1<=$count_theparents-1; $k1++){
if ($content_dump[$i]->parents->id == $theparents[$k1]->id){
/* Yeay... we found the parent page of our content_dump item... */
$content_dump[$i]->parents->alias = $theparents[$k1]->alias;
$content_dump[$i]->parents->title = $theparents[$k1]->title;
break;
}
}
}
if ($users == true) {
// Compare against user_ids IDs to expand user data (extensions)
for ($k3=0; $k3<=$count_theusers-1; $k3++){
if ($content_dump[$i]->created->by == $theusers[$k3]->id) {
// we found the user who created the page
$content_dump[$i]->created->by = $theusers[$k3];
}
if ($content_dump[$i]->modified->by == $theusers[$k3]->id) {
// we found the user who made the last modification
$content_dump[$i]->modified->by = $theusers[$k3];
}
}
}
if ($extension == true) {
// Compare against content_prop IDs to expand entry data (extensions)
for ($k2=0; $k2<=$count_content_props-1; $k2++){
if ($content_dump[$i]->content->id == $content_props[$k2]['content_id']){
//We found out that there is some extra content for this page, so let's flag the item
$content_dump[$i]->extension = 1;
//Now let's assign the data (remember: only when available) to class names (we use the prop_names as class-names)
$content_dump[$i]->extensions->$content_props[$k2]['prop_name']->data = $content_props[$k2]['content'];
if ($c_smarty == "compile") {
// Extension data fields should be compiled
$smarty->_compile_source('temporary template', $content_dump[$i]->content->data, $_compiled);
@ob_start();
$smarty->_eval('?>' . $_compiled);
$content_dump[$i]->content->data = @ob_get_contents();
@ob_end_clean();
} elseif ($c_smarty == "strip") {
// Extension data field should be stripped
$content_dump[$i]->content->data = strip_out($content_dump[$i]->content->data,'smarty');
} else {
}
if ($c_html == "strip" ) {
// HTML, JS and inline styles should be stripped
$content_dump[$i]->extensions->$content_props[$k2]['prop_name']->data = strip_out($content_dump[$i]->extensions->$content_props[$k2]['prop_name']->data,'html');
}
$content_dump[$i]->extensions->$content_props[$k2]['prop_name']->length = strlen($content_dump[$i]->extensions->$content_props[$k2]['prop_name']->data);
}
}
}
if ($c_smarty == "compile") {
if ($content_dump[$i]->content->id != $gCms->variables['content_id']) {
// ^prevent calling page to be processed in smarty
// THX to NaN for the great hint with the smarty processing
$smarty->_compile_source('temporary template', $content_dump[$i]->content->data, $_compiled);
@ob_start();
$smarty->_eval('?>' . $_compiled);
$content_dump[$i]->content->data = @ob_get_contents();
@ob_end_clean();
}
} elseif ($c_smarty == "strip") {
$content_dump[$i]->content->data = strip_out($content_dump[$i]->content->data,'smarty');
}
if ($c_html == "strip" ) {
$content_dump[$i]->content->data = strip_out($content_dump[$i]->content->data,'html');
}
}
/*
Return Results
====================================================================================================
Only thing left... assign our result to smarty... and the you can go templating like crazy ;)
*/
$smarty = &$gCms->GetSmarty();
$smarty->assign($assign, $content_dump);
if (isset($pager_info)){$smarty->assign('pager_info', $pager_info);}
setlocale(LC_TIME,'');
return;
}
function smarty_cms_help_function_content_dump() {
?>
Version info: 0.8
This plug-in version was created: Feb 2009
What can "content dump" do for you?
"Content Dump" is the swiss army knife amongst the options for dumping your sites content
into a single page. It offers a variety of independent parameters than can be combined to
cater for a lot of your site internal content distribution needs.
Just attach some parameters and limit/organize the output to your data requirements. The
smarty output allows you to freely design the results in your template or content block
(from the regular editors view - though you should always prefer to do it in the template). With smarty you can even control the output by limiting it to specific values (e.g. only user "John Doe") or use modifiers to further manipulate
the content.
For daily CMS needs - just like a swiss army knife - just like CMSMS.
---------------------------
Parameters:
---------------------------
Following a description of the available parameters. You do not have to obey a specific order for them. Also you can use none of them or all 19, it's up to you...
---------------------------
Select items
---------------------------
Selecting the main content-block
assign can be used to define the outputs name to something else than $dump[n]. $dump[n] will be kept as the default for downward compatibility.
{content_dump assign="my_var_name"}
Now you can access your date like this: $my_var_name[0]->content->alias. This makes it much easier to use the plug-in several times in a single template.
Selecting the main content-block
block_name can be used to define the content block you want to use as the $dump[n]->content->data element. Per default, it will be "content_en", the page standard content block. If the block you want to show is {content block="summary"} in your source page's template, you would call it like in the following example:
{content_dump block_name="summary"}
---
Where should the dump begin?
start_id can be used to define a starting point for your content collection. If not specified, it will begin with id "-1" and thus include all matching pages from all pages. A nice trick to use the tag in several pages based on the same template and limit the tag to this site area is to set start_id=$content_id. This way, you use the viewed page's id as the initial page and ignore all other content folders.
{content_dump start_id=16}
---
Skip the first X items (offset).
limit_start will allow you to do that. State the number of the item you would like your output to begin with. Default is 0
{content_dump limit_start=5}
---
Limit the output to a specific number of items.
limit_count can be used to limit the output to a specific number. In combination with page, it will define the size of a page.
{content_dump limit_count=10}
---
How can I paginate content_dump?
page can be used to generate a page based view. Value is page number. It will basically move the view you have on the results by the number of items specified in limit_count. It alters the limit_start by adding limit_count to it, each time an increasing page is selected. Let's say you have limit_start=0 and limit_count=5, page=2 will alter limit_start to be 6.
Usage of this parameter will provide some extra smarty data elements. $pager_info->current, $pager_info->max and $pager_info->size. Representing the currently selected page, the maximum page available and the page size. Use smarty and this data to build easy and complex pagers alike.
{content_dump limit_count=5 page=2}
---
Show also inactive pages or only inactive pages.
active can be used to control how the ACTIVE flag of pages should be interpreted. "force" shows all pages regardless of status. "active" show active pages only (default). "inactive" show inactive pages only.
{content_dump active="force"}
---
Show in menu - what about that?
show_in_menu can be used to control how the SHOW_in_menu flag of pages should be interpreted. "force" shows all pages regardless of status. "show" show pages set to "Show in Menu" only (default). "hidden" show pages that are set to "Don't Show in Menu" only.
{content_dump show_in_menu="hidden"}
---------------------------
Filter items
---------------------------
---
Filter for specific content (e.g. check if data fields contain the word "world")
filter can be used to limit the results to entries which contain specific words or phrases or to exlude such items. Use boolean logic. e.g. filter="-hello" to exclude items that contain the word "hello" in any of their content->data or extension->itemname->data elements or filter="world" to limit the results to those items that contain the word "world" in any of their data elements.
{content_dump filter="world"}
---
Exclude or limit (filter) the output to pages with matching alias prefix
prefix can be used to state the prefix or prefixes that should be considered for exluding from the collection or that should be the only pages in the collection. Several prefix are seperated by comma. E.g. {content_dump prefix="private_,special_"}
{content_dump prefix="prefixname"}
---
How should the prefix or list of prefix(es) be handled?
prefix_mode Prefix-mode is used to controll the handling of the prefix(es). "force", "neutral" and "hide" are the available values. Standard mode is neutral that will disregard any available prefix. Forced mode only shows pages with one of the stated prefixes. Hide will exlude pages with the prefix from the items returned.
{content_dump prefix_mode="hide"}
---
How can I limit the output to specific hierarchy levels (e.g. depth) ?
depth is used to control the what hierarchy levels should be considered for output. It takes two integer values seperated by comma (e.g. depth="-1,3"}. The first value defines the starting hierarchy. -1 = start with content_dump, n = start with specific hierarchy level [0 and 1 both return first level].
The second value defines the number of additional levels added to the collection. 0 = no depth, siblings of page specified with first depth value are returned (if not excluded otherwise). n = number of additional level relative to the level specified with first depth value.
Both values must be used!
{content_dump depth="-1,3"}
---------------------------
Exclude items
---------------------------
Exclude single items from the list
exclude allows you to remove specific pages from the results. It takes any number of content IDs seperated by comma. Especially when forcing content_dump to compile smarty in found content-blocks, you can use this tag to break endless recursions or for any other reason where you want specific pages not to appear.
{content_dump exclude="13,23,53,12,32"}
---
Just show the data of a specific element
this_only is a parameter that will limit the result to this specific ID.
{content_dump this_only=55}
---------------------------
Add more data to the item
---------------------------
Get more information about parent pages
parents can be used to request more information about the parent pages (alias and title). Possible values are true or false. Using this parameters allows you to use the data element $dump[n]->parents->alias or $dump[n]->parents->title. The data element $dump[n]->parents->id will be provided in any case. Per default it is deactivated.
{content_dump parents=true}
---
Get more information about users that wrote/edited the content
users can be used to request more information about the users who last edited and created the content. Possible values are true or false. Per default $dump[n]->created->by and $dump[n]->modified->by will only return the user ID. If set to true, the mentioned class elements will be expanded by detailed user info (first-, last- and user name).
{content_dump users=true}
---
I want to use more content-blocks from the pages
extensions is your choice then. It takes a comma seperated list of content_blocks. If any of them (for an item) features content, $dump[n]->extension will be "1", other wise it will be "0" (default). This can be used to check for availability of "more" data. Each content_block will be added as a class below $dump[n]->extensions. E.g. {content block="more_text"} will be available as $dump[n]->extensions->more_text->data together with $dump[n]->extensions->more_text->length. Ideally, your content block names do not feature special charcacters and not " " or "-", use "_" instead.
{content_dump extensions="summary,image,other_block_name"}
---------------------------
Process data from items
---------------------------
Set variable name for output
assign can be used to assign the outout to a specific variable name. If not set, variable will be named $dump for smarty output.
{content_dump assign="my_var_name"}
---
Change the date/time format to someting else
dateformat can be used to format the date output of content_dump. Check http://de.php.net/strftime for more ifo on the date format options. Per default it is set to "%A, %e %B %Y" (e.g. Sat, 20 September 2008). It is used for the two time stamps $dump[n]->created->date and $dump[n]->modified->date that are always returned with each item.
{content_dump dateformat="%A, %e %B %Y"}
Change the date/time locale to someting else
cdlocale can be used to specify a specific locale for your output. E.g. your page is danish and your site/server is set to this locale - but for the generation of valid RSS you might need the US date/time locale.
{content_dump cdlocale="en-us"}
---
Change the date format locale to someting else
locale can be used to alter the locale used for the timestamp (e.g. system is Danish but you need US day names for XML).
{content_dump locale="en-US"}
---
I want smarty from content-fields to be compiled, or removed
do_smarty controls how smarty data that may be retrieved should be handled. There are three options "compile, neutral and strip". "compile" compiles smarty data in in the pages found. "neutral" prints out the smarty code as regular text and is the default setting. "strip" deletes all smarty code from your page (well, everything between { and }).
However, be carefull not to construct a query that would have to compile
itself, this will result in an out of memory error due to endless recursion.
If you use this tag only once with the compile parameter in your site,
no problem, it prevents itself from being rendered. But if you have
another occurences of this tag that would include the page that
is calling the currently processed tag with compile="true", you should
exclude all of these pages (content dump does not check for the compile
parameter of other occurences of the tag).
If that called tag would feature other content blocks.. then again all would work nice. Just do not construct something with content_dump that is somewhere in the chain of events compiling itself.
{content_dump do_smarty="compile"}
---
Remove HTML from content elements so I can safely truncate the data
html is a parameter that allows you to remove any HTML, JavaScript and CSS from a content-block. "strip" and "neutral" are the available options. "Neutral" will display the content as it is (after processing do_smarty settings) and is the default setting. "Strip" will remove the mentioned elements.
{content_dump html="neutral"}
---------------------------
Sort items
---------------------------
Primary sorting of data elements
first_sort sorts the found content by one of the following values: id, title, created, modified, owner, hierarchy (default), id_hierarchy, lasteditor, active, show (show in menu). For time based (like newest contents) use created, for last updated lists use modified (both need to be reversed with sort_order). Hint: Sorting by owner or lasteditor takes place by ID, not name!
{content_dump first_sort="owner"}
---
Set the direction of primary sorting
first_sort_order can be used to reverse the sorting filter. "up" and "down" are the available options, whereas "up" (A before B or yesterday before today) is the default direction.
{content_dump first_sort_order="up"}
---
Secondary sorting of data elements
second_sort sorts the found content by one of the following values: id, title, created, modified, owner, hierarchy, id_hierarchy, lasteditor, active, show (show in menu). For time based (like newest contents) use created, for last updated lists use modified (both need to be reversed with sort_order). Hint: Sorting by owner or lasteditor takes place by ID, not name!
{content_dump first_sort="owner"}
---
Set the direction of secondary sorting
second_sort_order can be used to reverse the sorting filter. "up" and "down" are the available options, whereas "up" (A before B or yesterday before today) is the default direction.
{content_dump first_sort_order="up"}
---------------------------
Maximum data structure for dump items:
---------------------------
$dump = array of classes
n = integer
$dump [ n ] -> item = Counter for items in current list (integer)
$dump [ n ] -> content -> id
$dump [ n ] -> content -> alias
$dump [ n ] -> content -> title
$dump [ n ] -> content -> show
$dump [ n ] -> content -> active
$dump [ n ] -> content -> data
$dump [ n ] -> parents -> id
$dump [ n ] -> parents -> alias
$dump [ n ] -> parents -> title
$dump [ n ] -> created -> date
$dump [ n ] -> created -> by -> username
$dump [ n ] -> created -> by -> last_name
$dump [ n ] -> created -> by -> first_name
$dump [ n ] -> created -> by -> email
$dump [ n ] -> modified -> date
$dump [ n ] -> modified -> by -> username
$dump [ n ] -> modified -> by -> last_name
$dump [ n ] -> modified -> by -> first_name
$dump [ n ] -> modified -> by -> email
$dump [ n ] -> extension
And for each extension you have named, you will get an equally named class element below
$dump [ n ] -> extensions
e.g.
$dump [ n ] -> extensions -> summary -> data
$dump [ n ] -> extensions -> summary -> length
---------------------------
Date structure of pager information
---------------------------
$pager_info -> current
$pager_info -> max
$pager_info -> size
---------------------------
Userfull smarty snippets for working with content_dump
---------------------------
Below you find some code snippets you can use in your templates in conjunctionn with content_dump
Prepare template for paging
{assign var=page_call value=$smarty.get.show_page}
{if $page_call == ""}{assign var=page_call value=1}{/if}
This will listen for URL parameter called show_page and its value. If no parameter found, create is and assign value 1. Use $page_call as the value of the page parameter {...page=$page_call...}
"newer" "older" pager
{if $page_call > 1 }
<a href="blog.htm?show_page={$pager_info->current-1}">newer articles</a>
{/if}
{if $pager_info->max > $page_call}
<a href="blog.htm?show_page={$pager_info->current+1}">older articles</a>
{/if}
Page number list pager
{section name="i" start=1 loop=$pager_info->max+1 step=1}
<a href="blog.htm?show_page={$smarty.section.i.index}">{$smarty.section.i.index}</a>
{/section}
Walk through all available elements
{content_dump ... }
{foreach from=$dump item=dump}
{$dump->content->data}
{/foreach}
Display read more link
{content_dump ... }
{foreach from=$dump item=dump}
{if $dump->extension == 1}
<a href="{$dump->content->alias}.htm">read more</a>
{/if}
{/foreach}
---
Version Information And History
Author: Nils Haack <hello@opticalvalve.com>
Version: 0.8 (Feb 2009)
Change History:
- 0.8 Parameter to SET LOCALE for time and date output added, ASSIGN parameter added, bugfix in pagination (active & show in menu), hierarchy behaviour changed.
- 0.7.1 FILTER behaviour changed - now only filters primary block (param: block_name) - NOT RELEASED
- 0.7 Added ALIAS FILTERING (include/exclude PREFIX), hierarchy filtering and boolean content filtering
- 0.6.1 BUGFIX: wrong $pager_info->max returned under specific conditions
- View full version history on about page
Plug-in Information
Content_Dump is a multi-purpose content aggregation tool for getting contents from one place to another within a CMSms installation. It can be as precise as a single content-prop of a page or display full collections of pages and their elements.
The output is provided as a smarty data array. With the ability to serve data for all kind of activities, you can use it to build feature-rich paginated blogs, galleries, portfolios or other kinds of index-like presentations. The advantage: everything can be stored in pages and extra content blocks - keeping the learning curve low for editors by keeping a high flexibility for the site develeopment.
---
Version Information And History
Author: Nils Haack <hello@opticalvalve.com>
Version: 0.8 (Feb 2009)
Change History:
- 0.8 Parameter to SET LOCALE for time and date output added, ASSIGN parameter added, bugfix in pagination (active & show in menu), hierarchy behavior changed.
- 0.7.1 Filter behavior changed, less rigid on content extensions - NOT RELEASED
- 0.7 Added alias filtering (include/exclude prefix), hierarchy filtering and boolean content filtering
- 0.6.1 Bugfix: wrong $pager_info->max returned under specific conditions
- 0.6 Ability to load extra content props, html stripping, code-rework
- 0.5 Added "show_page" parameter and pagination mechanics
- 0.4.2 Fix in documentation (parameter "users" was not described) - NOT RELEASED
- 0.4.1 Bugfix: wrong limit_count if parameter "extension" is used
- 0.4 Added "extension" parameter, better parent loop-up, code clean-up and code comments
- 0.3 Added "parents", "active" and "show_in_menu" parameter and smarty compiling/stripping
- 0.2.1 User data look-up is now optional
- 0.2 Added "this_only", "limit_start" and "limit_count" parameters
- 0.1 Initial publication