Box article list

box parameters:

Parameter name Value Description
add_to_printed 0 | 1 0 - default
exclude_printed 0 | 1 0 - default
TITLE string custom title for box, available in template via {TITLE}
BOX_ID string custom html id for box, available in template via {BOX_ID}

Search parameters:

Parameter name Value Description
search_limit integer max number of articles to retrieve
pg integer 0 - default
search_order 'ascending'
'descending'
applies to search_sort_by
offset integer query offset, 0 based
fields string comma separated database fields
search_options array compact form of search parameters
search_status -1 | 0 | 1 | 2 -1: archived
0: pending
1: active
2: headline
search_status_limit 0 | 1 0: all articles (default for administration)
1: active and headline articles (default for front end)
search_id integer article id
search_cid string comma separated category ids
search_author string whole author name or a part of it
search_author_exact_name 0 | 1 0: search author name with like
1:search exact author name
0 default
search_query string keywords, implemented trough mysql full text search (mysql limitation stands) or like for title only
search_title_only 0 | 1 0: full text search against title, abstract and body
1: title only search
search_search_date integer number of days
search_before_after 0 | 1 0: before
1: after
applies to search_search_date
search_by_date integer strtotime recognizable date format
search_by_year integer year constrain
search_by_month integer month constrain
search_by_day integer day of month constrain
search_tag string tag name
search_tag_id integer tag id
search_user_id integer author id
search_related integer article id
search_exclude_id string comma separated article ids
search_sort_by 'most_popular'
'most_commented'
'most_emailed'
'id'
'category_id'
'user_id'
'author'
'title'
'created'
'last_read'
'times_read'
'today_read'
'status'
'sefriendly'
'order_num'
'emailed'
'vote_num'
'vote_sum'
sort result by criteria

Assignments:

Parameter name Value Description
article_list_object object ArticlesList object
article_list array each item is an Articles object
TITLE string pass trough title parameter
BOX_ID string pass trough html id parameter