add_news
add_news_category
build_news_sitemap
create_selection_list_news
create_selection_list_news_categories
delete_news
delete_news_category
dispatch_news_notification
edit_news
edit_news_category
import_foreign_news_html
import_rss_fields
render_news_box
render_news_category_box
send_rss_ping
add_news(\SHORT_TEXT $title, \LONG_TEXT $news, \?ID_TEXT $author= null
, \BINARY $validated= 1
, \BINARY $allow_rating= 1
, \SHORT_INTEGER $allow_comments= 1
, \BINARY $allow_trackbacks= 1
, \LONG_TEXT $notes= ''
, \LONG_TEXT $news_article= ''
, \?AUTO_LINK $main_news_category= null
, \?array $news_categories= null
, \?TIME $time= null
, \?MEMBER $submitter= null
, integer $views= 0
, \?TIME $edit_date= null
, \?AUTO_LINK $id= null
, \URLPATH $image= ''
, \?SHORT_TEXT $meta_keywords= ''
, \?LONG_TEXT $meta_description= ''
) : \AUTO_LINK
package | news |
---|
\SHORT_TEXT
The news title
\LONG_TEXT
The news summary (or if not an article, the full news)
\?ID_TEXT
The news author (possibly, a link to an existing author in the system, but does not need to be) (null: current username)
\BINARY
Whether the news has been validated
\BINARY
Whether the news may be rated
\SHORT_INTEGER
Whether comments are allowed (0=no, 1=yes, 2=review style)
\BINARY
Whether the news may have trackbacks
\LONG_TEXT
Notes for the news
\LONG_TEXT
The news entry (blank means no entry)
\?AUTO_LINK
The primary news category (null: personal)
\?array
The IDs of the news categories that this is in (null: none)
\?TIME
The time of submission (null: now)
\?MEMBER
The news submitter (null: current member)
integer
The number of views the article has had
\?TIME
The edit date (null: never)
\?AUTO_LINK
Force an ID (null: don't force an ID)
\URLPATH
URL to the image for the news entry (blank: use cat image)
\?SHORT_TEXT
Meta keywords for this resource (null: do not edit) (blank: implicit)
\?LONG_TEXT
Meta description for this resource (null: do not edit) (blank: implicit)
\AUTO_LINK
The ID of the news just addedadd_news_category(\SHORT_TEXT $title, \ID_TEXT $img, \LONG_TEXT $notes, \?MEMBER $owner= null
, \?AUTO_LINK $id= null
) : \AUTO_LINK
package | news |
---|
\SHORT_TEXT
The news category title
\ID_TEXT
The theme image ID of the picture to use for the news category
\LONG_TEXT
Notes for the news category
\?MEMBER
The owner (null: public)
\?AUTO_LINK
Force an ID (null: don't force an ID)
\AUTO_LINK
The ID of our new news categorybuild_news_sitemap()
package | news |
---|
create_selection_list_news(\?AUTO_LINK $it, \?MEMBER $only_owned= null
, boolean $editable_filter= false
, boolean $only_in_blog= false
) : \Tempcode
package | news |
---|
\?AUTO_LINK
The selected news entry (null: none)
\?MEMBER
Limit news to those submitted by this member (null: show all)
boolean
Whether to only show for what may be edited by the current member
boolean
Whether to only show blog posts
\Tempcode
The listcreate_selection_list_news_categories(\?mixed $it= null
, boolean $show_all_personal_categories= false
, boolean $addable_filter= false
, boolean $only_existing= false
, \?boolean $only_blogs= null
, boolean $prefer_not_blog_selected= false
, \?TIME $updated_since= null
) : \Tempcode
package | news |
---|
\?mixed
The selected news category. Array or AUTO_LINK (null: personal)
boolean
Whether to add all personal categories into the list (for things like the adminzone, where all categories must be shown, regardless of permissions)
boolean
Whether to only show for what may be added to by the current member
boolean
Whether to limit to only existing cats (otherwise we dynamically add unstarted blogs)
\?boolean
Whether to limit to only show blog categories (null: don't care, true: blogs only, false: no blogs)
boolean
Whether to prefer to choose a non-blog category as the default
\?TIME
Time from which content must be updated (null: no limit).
\Tempcode
The Tempcode for the news category select listdelete_news(\AUTO_LINK $id)
delete_news_category(\AUTO_LINK $id)
dispatch_news_notification(\AUTO_LINK $id, \SHORT_TEXT $title, \AUTO_LINK $main_news_category)
package | news |
---|
\AUTO_LINK
The ID of the news
\SHORT_TEXT
The title
\AUTO_LINK
The main news category
edit_news(\AUTO_LINK $id, \SHORT_TEXT $title, \LONG_TEXT $news, \ID_TEXT $author, \BINARY $validated, \BINARY $allow_rating, \SHORT_INTEGER $allow_comments, \BINARY $allow_trackbacks, \LONG_TEXT $notes, \LONG_TEXT $news_article, \AUTO_LINK $main_news_category, \?array $news_categories, \SHORT_TEXT $meta_keywords, \LONG_TEXT $meta_description, \?URLPATH $image, \?TIME $add_time= null
, \?TIME $edit_time= null
, \?integer $views= null
, \?MEMBER $submitter= null
, boolean $null_is_literal= false
)
package | news |
---|
\AUTO_LINK
The ID of the news to edit
\SHORT_TEXT
The news title
\LONG_TEXT
The news summary (or if not an article, the full news)
\ID_TEXT
The news author (possibly, a link to an existing author in the system, but does not need to be)
\BINARY
Whether the news has been validated
\BINARY
Whether the news may be rated
\SHORT_INTEGER
Whether comments are allowed (0=no, 1=yes, 2=review style)
\BINARY
Whether the news may have trackbacks
\LONG_TEXT
Notes for the news
\LONG_TEXT
The news entry (blank means no entry)
\AUTO_LINK
The primary news category (null: personal)
\?array
The IDs of the news categories that this is in (null: do not change)
\SHORT_TEXT
Meta keywords
\LONG_TEXT
Meta description
\?URLPATH
URL to the image for the news entry (blank: use cat image) (null: don't delete existing)
\?TIME
Add time (null: do not change)
\?TIME
Edit time (null: either means current time, or if $null_is_literal, means reset to to NULL)
\?integer
Number of views (null: do not change)
\?MEMBER
Submitter (null: do not change)
boolean
Determines whether some NULLs passed mean 'use a default' or literally mean 'set to NULL'
edit_news_category(\AUTO_LINK $id, \?SHORT_TEXT $title, \?SHORT_TEXT $img, \?LONG_TEXT $notes, \?MEMBER $owner)
package | news |
---|
\AUTO_LINK
The news category to edit
\?SHORT_TEXT
The title (null: keep as-is)
\?SHORT_TEXT
The image (null: keep as-is)
\?LONG_TEXT
The notes (null: keep as-is)
\?MEMBER
The owner (null: public)
import_foreign_news_html(string $html, boolean $force_linebreaks = false
) : string
package | news |
---|
string
HTML
boolean
Whether to add in HTML line breaks from whitespace ones.
string
Comcodeimport_rss_fields(boolean $import_to_blog) : \Tempcode
package | news |
---|
boolean
Whether to import to blogs, by default
\Tempcode
UI fieldsrender_news_box(array $row, \ID_TEXT $zone= '_SEARCH'
, boolean $give_context= true
, boolean $brief= false
, \ID_TEXT $guid= ''
) : \Tempcode
package | news |
---|
array
The news row
\ID_TEXT
The zone our news module is in
boolean
Whether to include context (i.e. say WHAT this is, not just show the actual content)
boolean
Whether to use the brief styling
\ID_TEXT
Overridden GUID to send to templates (blank: none)
\Tempcode
The boxrender_news_category_box(array $row, \ID_TEXT $zone= '_SEARCH'
, boolean $give_context= true
, boolean $attach_to_url_filter= false
, \?integer $blogs= null
, \ID_TEXT $guid= ''
) : \Tempcode
package | news |
---|
array
The database field row of it
\ID_TEXT
The zone to use
boolean
Whether to include context (i.e. say WHAT this is, not just show the actual content)
boolean
Whether to copy through any filter parameters in the URL, under the basis that they are associated with what this box is browsing
\?integer
What to show (null: news and blogs, 0: news, 1: blogs)
\ID_TEXT
Overridden GUID to send to templates (blank: none)
\Tempcode
A box for it, linking to the full pagesend_rss_ping(boolean $show_errors = true
) : string