3 * StatusNet, the distributed open-source microblogging tool
5 * Data class for Profile preferences
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Mikael Nordfeldth <mmn@hethane.se>
25 * @copyright 2013 Free Software Foundation, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://www.gnu.org/software/social/
30 class Profile_prefs extends Managed_DataObject
32 public $__table = 'profile_prefs'; // table name
33 public $profile_id; // int(4) primary_key not_null
34 public $namespace; // varchar(255) not_null
35 public $topic; // varchar(255) not_null
37 public $created; // datetime not_null default_0000-00-00%2000%3A00%3A00
38 public $modified; // timestamp not_null default_CURRENT_TIMESTAMP
40 public static function schemaDef()
44 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'user'),
45 'namespace' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'namespace, like pluginname or category'),
46 'topic' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'preference key, i.e. description, age...'),
47 'data' => array('type' => 'blob', 'description' => 'topic data, may be anything'),
48 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
49 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
51 'primary key' => array('profile_id', 'namespace', 'topic'),
52 'foreign keys' => array(
53 'profile_prefs_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
56 'profile_prefs_profile_id_idx' => array('profile_id'),
61 static function getNamespacePrefs(Profile $profile, $namespace, array $topic=array())
64 $prefs = new Profile_prefs();
65 $prefs->profile_id = $profile->id;
66 $prefs->namespace = $namespace;
69 $prefs = self::pivotGet('profile_id', $profile->id, array('namespace'=>$namespace, 'topic'=>$topic));
72 if (empty($prefs->N)) {
73 throw new NoResultException($prefs);
79 static function getNamespace(Profile $profile, $namespace, array $topic=array())
81 $prefs = self::getNamespacePrefs($profile, $namespace, $topic);
82 return $prefs->fetchAll();
85 static function getAll(Profile $profile)
88 $prefs = self::listFind('profile_id', $profile->id);
89 } catch (NoResultException $e) {
94 while ($entry = $prefs->fetch()) {
95 if (!isset($list[$entry->namespace])) {
96 $list[$entry->namespace] = array();
98 $list[$entry->namespace][$entry->topic] = $entry->data;
103 static function getTopic(Profile $profile, $namespace, $topic) {
104 $pref = new Profile_prefs;
105 $pref->profile_id = $profile->id;
106 $pref->namespace = $namespace;
107 $pref->topic = $topic;
109 if (!$pref->find(true)) {
110 throw new NoResultException($pref);
115 static function getData(Profile $profile, $namespace, $topic, $def=null) {
117 $pref = self::getTopic($profile, $namespace, $topic);
118 } catch (NoResultException $e) {
120 // If no default value was set, continue the exception.
123 // If there was a default value, return that.
129 static function getConfigData(Profile $profile, $namespace, $topic) {
131 $data = self::getData($profile, $namespace, $topic);
132 } catch (NoResultException $e) {
133 $data = common_config($namespace, $topic);
139 * Sets a profile preference based on Profile, namespace and topic
141 * @param Profile $profile Which profile this is for
142 * @param string $namespace Under which namespace (pluginname etc.)
143 * @param string $topic Preference name (think key in key-val store)
144 * @param string $data Data to be put into preference storage, null means delete
146 * @return true if changes are made, false if no action taken
147 * @throws ServerException if preference could not be saved
149 static function setData(Profile $profile, $namespace, $topic, $data=null) {
151 $pref = self::getTopic($profile, $namespace, $topic);
152 if (is_null($data)) {
155 $orig = clone($pref);
157 $pref->update($orig);
160 } catch (NoResultException $e) {
161 if (is_null($data)) {
162 return false; // No action taken
166 $pref = new Profile_prefs();
167 $pref->profile_id = $profile->id;
168 $pref->namespace = $namespace;
169 $pref->topic = $topic;
171 $pref->created = common_sql_now();
173 if ($pref->insert() === false) {
174 throw new ServerException('Could not save profile preference.');