Class: CollectionSettings

Source Location: /qp_inc/collections/model/_collsettings.class.php

Class CollectionSettings

Class Overview

Class to handle the settings for collections/blogs

Located in /qp_inc/collections/model/_collsettings.class.php [line 38]

AbstractSettings
   |
   --CollectionSettings

Properties

$_defaults

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From AbstractSettings

AbstractSettings::$all_loaded

AbstractSettings::$cache

AbstractSettings::$cache_by_col_keys

AbstractSettings::$col_key_names

AbstractSettings::$col_value_name

AbstractSettings::$db_table_name

Inherited From AbstractSettings

AbstractSettings::AbstractSettings()

Constructor.

AbstractSettings::dbupdate()

Commit changed settings to DB.

AbstractSettings::delete()

Remove a setting.

AbstractSettings::delete_array()

Delete an array of values.

AbstractSettings::get()

Get a setting from the DB settings table.

AbstractSettings::get_cond()

Only set the first variable (passed by reference) if we could retrieve a setting.

AbstractSettings::get_default()

Get the default for the last key of $col_key_names

AbstractSettings::load_all()

Load all settings, disregarding the derived classes setting of $cache_by_col_keys
useful if you know that you want to get
all user settings for example.

AbstractSettings::reset()

Reset cache (includes settings to be written to DB).

AbstractSettings::restore_defaults()

Delete values for $_defaults in DB.

AbstractSettings::set()

Temporarily sets a setting (dbupdate() writes it to DB).

AbstractSettings::set_array()

Set an array of values.

AbstractSettings::_load()

Loads the settings. Not meant to be called directly, but gets called when needed.

[ Top ]

Property Summary

mixed

$_defaults

The default settings to use, when a setting is not defined in the database.

[ Top ]

Method Summary

CollectionSettings	CollectionSettings()	Constructor
boolean	_load()	Loads the settings. Not meant to be called directly, but gets called when needed.

[ Top ]

Properties

mixed $_defaults = array(
// Blog settings -> General subtab
// "Content / Posts" section
'orderby' => 'datestart',
'orderdir' => 'DESC',
'what_to_show' => 'posts', // 'posts', 'days'
'posts_per_page' => '5', // * also on URLs subtab *
'archive_mode' => 'monthly', // 'monthly', 'weekly', 'daily', 'postbypost'
// "Description" section
'blog_footer_text' => '©$year$ by $owner$',
'single_item_footer_text' => '',
// "Meta data" section
'xml_item_footer_text' => '<p><small><a href="$item_perm_url$" title="$item_title$">$item_title$</a></small></p>',
// "Aggregation" section
'aggregate_coll_IDs' => '',

// Blog settings -> Features subtab
// "Post options" section
'require_title' => 'optional', // 'required', 'optional', 'none'
// "Feedback options" section
'allow_rating' => 'never',
'new_feedback_status' => 'draft', // 'draft', 'published', 'deprecated'
// "RSS/Atom feeds" section
'feed_content' => 'normal',
'posts_per_feed' => '8',
// "Multiple authors" section
'use_workflow' => 0,
// "Subscriptions" section
'allow_subscriptions' => 0,
'send_subs_what' => 'excerpt', // 'none', 'excerpt', 'stop_more', 'full_item'
// "After each new post..." section
'ping_plugins' => '', // ping plugin codes, separated by comma
// "External Feeds" section
'atom_redirect' => '',
'rss2_redirect' => '',
// "Caching [Admin]" section
'cache_enabled' => 0,
// "Credits Page [Admin]" section
'credits_page' => 'credits',
'credit_sections' => 'template,plugins,contribs', // sections shown on credits page

// Blog settings -> Categories subtab
// "Categories for blog" section
'default_cat_ID' => NULL,

// Blog settings -> URLs subtab
// "Main page / post list" section
'default_noindex' => '0',
'canonical_homepage' => 1,
'relcanonical_homepage' => 1,
'paged_noindex' => '1',
'paged_nofollowto' => '0',
'title_link_type' => 'permalink',
'main_content' => 'normal',
'permalinks' => 'single', // 'single', 'archive', 'subchap'
// "Single post pages / "Permalink" pages" section
'single_links' => 'ymd',
'canonical_item_urls' => 1,
'relcanonical_item_urls' => 1,
'excerpts_meta_description' => '0',
// "Category pages" section
'chapter_links' => 'chapters', // 'param_num', 'subchap', 'chapters'
'category_prefix' => '',
'canonical_cat_urls' => 1,
'relcanonical_cat_urls' => 1,
'chapter_noindex' => '1',
'chapter_content' => 'excerpt',
'chapter_posts_per_page' => NULL,
'posts_per_page' => '5', // * also on General subtab *
'catdir_noindex' => '1',
'categories_meta_description' => '0',
// "Tag pages" section
'tag_links' => 'colon', // 'param', 'colon', 'semicolon' -- fp> we want this changed to prefix only for new blogs only
'tag_prefix' => '', // fp> fp> we want this changed to prefix only for new blogs only
'tag_rel_attrib' => 1, // rel="tag" attribute for tag links (http://microformats.org/wiki/rel-tag) -- valid only in prefix-only mode
'canonical_tag_urls' => 1,
'relcanonical_tag_urls' => 1,
'tag_noindex' => '1',
'tag_content' => 'excerpt',
'tag_posts_per_page' => NULL,
// ""By date" archives" section
'archive_links' => 'extrapath', // param, extrapath
'canonical_archive_urls' => 1,
'relcanonical_archive_urls' => 1,
'archive_noindex' => '1',
'archive_nofollowto' => '0',
'archive_content' => 'excerpt',
'archive_posts_per_page' => '100',
'arcdir_noindex' => '1',
// "Other filtered pages" section
'filtered_noindex' => '1',
'filtered_content' => 'excerpt',
// "Other pages" section
'feedback-popup_noindex' => '1',
'msgform_noindex' => '1',
'special_noindex' => '1',
'404_response' => '404',
) [line 46]

The default settings to use, when a setting is not defined in the database.

API Tags:

Access:

protected

Information Tags:

Todo:

EdB: IMPORTANT! make this be configurable new blog defaults one day

Redefinition of:

AbstractSettings::$_defaults: Default settings.

[ Top ]

Methods

Constructor CollectionSettings [line 149]

CollectionSettings CollectionSettings(
)

Constructor

[ Top ]

_load [line 163]

boolean _load(
string
$coll_ID, string
$arg 
)

Loads the settings. Not meant to be called directly, but gets called when needed.

Parameters:

string	$coll_ID:	First column key
string	$arg:	Second column key

API Tags:

Access:

protected

Redefinition of:

AbstractSettings::_load(): Loads the settings. Not meant to be called directly, but gets called when needed.

[ Top ]

hic sunt dracones

	collections

[ class tree: collections ] [ index: collections ] [ all elements ]