Docs For Class CollectionSettings

Class Overview

Class to handle the settings for collections/blogs

Located in /blogs/inc/collections/model/_collsettings.class.php [line 40]

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::param_Request() Get a param from Request and save it to Settings, or default to previously saved user setting. 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.

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::param_Request()

Get a param from Request and save it to Settings, or default to previously saved user setting.

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(
// Home page settings:
'what_to_show' => 'posts', // posts, days
'main_content' => 'normal',
'posts_per_page' => '5',
'canonical_homepage' => 1, // Redirect homepage to its canonical Url?
'relcanonical_homepage' => 1, // If no 301, fall back to rel="canoncial" ?
'default_noindex' => '0', // META NOINDEX on Default blog page
// the following are actually general params but are probably best understood if being presented with the home page params
'orderby' => 'datestart',
'orderdir' => 'DESC',
'title_link_type' => 'permalink',
'permalinks' => 'single', // single, archive, subchap

// Page 2,3,4..; settings:
'paged_noindex' => '1', // META NOINDEX on following blog pages
'paged_nofollowto' => '0', // NOFOLLOW on links to following blog pages

// Single post settings:
'canonical_item_urls' => 1, // Redirect posts to their canonical Url?
'relcanonical_item_urls' => 1, // If no 301, fall back to rel="canoncial" ?
'single_links' => 'ymd',
'single_item_footer_text' => '',

// Comment settings:
'new_feedback_status' => 'draft', // 'draft', 'published' or 'deprecated'
'allow_rating' => 'never',
'comments_orderdir' => 'ASC',

// Archive settings:
'arcdir_noindex' => '1', // META NOINDEX on Archive directory
'archive_mode' => 'monthly', // monthly, weekly, daily, postbypost
'archive_links' => 'extrapath', // param, extrapath
'canonical_archive_urls' => 1, // Redirect archives to their canonical URL?
'relcanonical_archive_urls' => 1, // If no 301, fall back to rel="canoncial" ?
'archive_content' => 'excerpt',
'archive_posts_per_page' => '100',
'archive_noindex' => '1', // META NOINDEX on Archive pages
'archive_nofollowto' => '0', // NOFOLLOW on links to archive pages
'archives_sort_order' => 'date',

// Chapter/Category settings:
'catdir_noindex' => '1', // META NOINDEX on Category directory
'chapter_links' => 'chapters', // 'param_num', 'subchap', 'chapters'
'canonical_cat_urls' => 1, // Redirect categories to their canonical URL?
'relcanonical_cat_urls' => 1, // If no 301, fall back to rel="canoncial" ?
'chapter_content' => 'excerpt',
'chapter_posts_per_page' => NULL,
'chapter_noindex' => '1', // META NOINDEX on Category pages
'category_prefix' => '',

// Tag page settings:
'tag_links' => 'colon', // 'param', 'semicolon' -- fp> we want this changed to prefix only for new blogs only
'canonical_tag_urls' => 1, // Redirect tag pages to their canonical Url?
'relcanonical_tag_urls' => 1, // If no 301, fall back to rel="canoncial" ?
'tag_content' => 'excerpt',
'tag_posts_per_page' => NULL,
'tag_noindex' => '1', // META NOINDEX on Tag pages
'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

// Other filtered pages:
'filtered_noindex' => '1', // META NOINDEX on other filtered pages
'filtered_content' => 'excerpt',

// Other pages:
'feedback-popup_noindex' => '1', // META NOINDEX on Feedback popups
'msgform_noindex' => '1', // META NOINDEX on Message forms
'special_noindex' => '1', // META NOINDEX on other special pages
'404_response' => '404',

// Feed settings: (should probably be duplicated for comment feed, category feeds, etc...)
'atom_redirect' => '',
'rss2_redirect' => '',
'feed_content' => 'normal',
'posts_per_feed' => '8',
'xml_item_footer_text' => '<p><small><a href="$item_perm_url$">Original post</a> blogged on <a href="http://b2evolution.net/">b2evolution</a>.</small></p>',
'image_size' => 'fit-320x320',

// Sitemaps settings:
'enable_sitemaps' => 1,

// General settings:
'cache_enabled' => 0,
'cache_enabled_widgets' => 0,
'default_cat_ID' => NULL, // Default Cat for new posts
'require_title' => 'required', // Is a title for items required ("required", "optional", "none")
'ping_plugins' => 'ping_pingomatic,ping_b2evonet,evo_twitter', // ping plugin codes, separated by comma
'allow_subscriptions' => 0, // Don't all email subscriptions by default
'use_workflow' => 0, // Don't use workflow by default
'aggregate_coll_IDs' => '',
'blog_footer_text' => '©$year$ by $owner$',
'max_footer_credits' => 3,
'enable_goto_blog' => 1, // Go to blog after publishing post
) [line 47]

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

API Tags:

Access:

protected

Redefinition of:

AbstractSettings::$_defaults: Default settings.

[ Top ]

Methods

Constructor CollectionSettings [line 147]

CollectionSettings CollectionSettings(
)

Constructor

[ Top ]

_load [line 161]

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 ]

Multilingual multiuser multiblog engine

Class: CollectionSettings

Class CollectionSettings

Packages

Classes

Files