tonyair/silverstripe-comments
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-comments synced 2024-10-22 11:05:49 +02:00
Code Issues Projects Releases Wiki Activity

FEATURE: added functions to add / remove commenting extension and configuration values

Browse Source
This commit is contained in:
Will Rossiter 2010-12-03 14:01:38 +13:00
parent 3b5afbce23
commit f0b544e50a
1 changed files with 79 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
code/Commenting.php
View File

@ -22,7 +22,7 @@ class Commenting {
/**
* @var array default configuration values
*/
private static $default_configuration = array(
private static $default_config = array(
'require_login' => false, // boolean, whether a user needs to login
'required_permission' => '', // required permission to comment (or array of permissions)
'use_ajax_commenting' => true, // use ajax to post comments.
@ -30,32 +30,94 @@ class Commenting {
'order_comments_by' => "\"Created\" DESC"
);
public function add($class, $settings) {
/**
* Adds commenting to a {@link DataObject}
*
* @param string classname to add commenting to
* @param array $setting Settings. See {@link self::$default_config} for
* available settings
*/
public static function add($class, array $settings) {
self::$enabled_classes[$class] = $settings;
Object::add_extension($class, 'CommentsExtension');
}
public function remove($class) {
/**
* Removes commenting from a {@link DataObject}. Does not remove existing comments
* but does remove the extension.
*
* @param string $class Class to remove {@link CommentsExtension} from
*/
public static function remove($class) {
if(isset(self::$enabled_classes[$class])) {
unset(self::$enabled_classes[$class]);
}
Object::remove_extension($class, 'CommentsExtension');
}
public function set_config($class, $configuration) {
/**
* Sets a value of a given config setting
*
* @param string $class
* @param string $key setting to change
* @param mixed $value value of the setting
*/
public static function set_config_value($class, $key, $value = false) {
if(isset(self::$enabled_classes[$class])) {
if(!is_array(self::$enabled_classes[$class])) self::$enabled_classes[$class] = array();
self::$enabled_classes[$class][$key] = $value;
}
else {
throw new Exception("$class does not have commenting enabled", E_USER_ERROR);
}
}
public function set_config_value($class, $key, $value = false) {
/**
* Returns a given config value for a commenting class
*
* @param string $class
* @param string $key config value to return
*
* @throws Exception
* @return mixed
*/
public static function get_config_value($class, $key) {
if(isset(self::$enabled_classes[$class])) {
// custom configuration
if(isset(self::$enabled_classes[$class][$key])) return self::$enabled_classes[$class][$key];
// default configuration
if(isset(self::$default_config[$key])) return self::$default_config[$key];
// config value doesn't exist
throw new Exception("Config ($key) is not a valid configuration value", E_USER_WARNING);
}
else {
throw new Exception("$class does not have commenting enabled", E_USER_ERROR);
}
}
public function get_config($class) {
}
public function get_config_value($class, $key) {
}
public function config_value_equals($class, $key, $value) {
/**
* Determines whether a config value on the commenting extension
* matches a given value.
*
* @param string $class
* @param string $key
* @param string $value Expected value
*
* @return bool
*/
public static function config_value_equals($class, $key, $value) {
try {
$check = self::get_config_value($class, $key);
if($check && ($check == $value)) return true;
}
catch(Exception $e) {}
return false;
}
}