From ac6486f12e3a51fc0b7b1433de881934d8029299 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Thu, 12 Aug 2010 21:19:12 -0700 Subject: [PATCH] Plugin file and data file for notice title --- plugins/NoticeTitle/NoticeTitlePlugin.php | 111 +++++++++++++++++++++ plugins/NoticeTitle/Notice_title.php | 116 ++++++++++++++++++++++ 2 files changed, 227 insertions(+) create mode 100644 plugins/NoticeTitle/NoticeTitlePlugin.php create mode 100644 plugins/NoticeTitle/Notice_title.php diff --git a/plugins/NoticeTitle/NoticeTitlePlugin.php b/plugins/NoticeTitle/NoticeTitlePlugin.php new file mode 100644 index 0000000000..9dfb4b21c2 --- /dev/null +++ b/plugins/NoticeTitle/NoticeTitlePlugin.php @@ -0,0 +1,111 @@ +. + * + * @category NoticeTitle + * @package StatusNet + * @author Evan Prodromou + * @copyright 2010 StatusNet, Inc. + * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0 + * @link http://status.net/ + */ + +if (!defined('STATUSNET')) { + // This check helps protect against security problems; + // your code file can't be executed directly from the web. + exit(1); +} + +define('NOTICE_TITLE_PLUGIN_VERSION', '0.1'); + +/** + * NoticeTitle plugin to add an optional title to notices. + * + * Stores notice titles in a secondary table, notice_title. + * + * @category NoticeTitle + * @package StatusNet + * @author Evan Prodromou + * @copyright 2010 StatusNet, Inc. + * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0 + * @link http://status.net/ + */ + +class NoticeTitlePlugin extends Plugin +{ + /** + * Database schema setup + * + * Add the notice_title helper table + * + * @see Schema + * @see ColumnDef + * + * @return boolean hook value; true means continue processing, false means stop. + */ + + function onCheckSchema() + { + $schema = Schema::get(); + + // For storing titles for notices + + $schema->ensureTable('notice_title', + array(new ColumnDef('notice_id', 'integer', null, true, 'PRI'), + new ColumnDef('title', 'varchar', 255, false))); + + return true; + } + + /** + * Load related modules when needed + * + * @param string $cls Name of the class to be loaded + * + * @return boolean hook value; true means continue processing, false means stop. + */ + + function onAutoload($cls) + { + $dir = dirname(__FILE__); + + switch ($cls) + { + case 'Notice_title': + include_once $dir . '/'.$cls.'.php'; + return false; + default: + return true; + } + } + + function onPluginVersion(&$versions) + { + $versions[] = array('name' => 'NoticeTitle', + 'version' => NOTICE_TITLE_PLUGIN_VERSION, + 'author' => 'Evan Prodromou', + 'homepage' => 'http://status.net/wiki/Plugin:NoticeTitle', + 'rawdescription' => + _m('Adds optional titles to notices')); + return true; + } +} + diff --git a/plugins/NoticeTitle/Notice_title.php b/plugins/NoticeTitle/Notice_title.php new file mode 100644 index 0000000000..ed71f13567 --- /dev/null +++ b/plugins/NoticeTitle/Notice_title.php @@ -0,0 +1,116 @@ + + * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3 + * @link http://status.net/ + * + * StatusNet - the distributed open-source microblogging tool + * Copyright (C) 2010, StatusNet, Inc. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +if (!defined('STATUSNET')) { + exit(1); +} + +require_once INSTALLDIR . '/classes/Memcached_DataObject.php'; + +/** + * Data class for notice titles + * + * @category Action + * @package StatusNet + * @author Evan Prodromou + * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3 + * @link http://status.net/ + * + * @see DB_DataObject + */ + +class Notice_title extends Memcached_DataObject +{ + public $__table = 'notice_title'; // table name + public $notice_id; // int(4) primary_key not_null + public $title; // varchar(255) + + /** + * Get an instance by key + * + * This is a utility method to get a single instance with a given key value. + * + * @param string $k Key to use to lookup (usually 'user_id' for this class) + * @param mixed $v Value to lookup + * + * @return Notice_title object found, or null for no hits + * + */ + + function staticGet($k, $v=null) + { + return Memcached_DataObject::staticGet('Notice_title', $k, $v); + } + + /** + * return table definition for DB_DataObject + * + * DB_DataObject needs to know something about the table to manipulate + * instances. This method provides all the DB_DataObject needs to know. + * + * @return array array of column definitions + */ + + function table() + { + return array('notice_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL, + 'title' => DB_DATAOBJECT_STR); + } + + /** + * return key definitions for DB_DataObject + * + * @return array list of key field names + */ + + function keys() + { + return array_keys($this->keyTypes()); + } + + /** + * return key definitions for Memcached_DataObject + */ + + function keyTypes() + { + return array('notice_id' => 'K'); + } + + /** + * Magic formula for non-autoincrementing integer primary keys + * + * @return array magic three-false array that stops auto-incrementing. + */ + + function sequenceKey() + { + return array(false, false, false); + } +}