plugins/YammerImport/classes/Yammer_state.php

   1 <?php
   2 /**
   3  * Data class for remembering Yammer import state
   4  *
   5  * PHP version 5
   6  *
   7  * @category Data
   8  * @package  StatusNet
   9  * @author   Brion Vibber <brion@status.net>
  10  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  11  * @link     http://status.net/
  12  *
  13  * StatusNet - the distributed open-source microblogging tool
  14  * Copyright (C) 2010, StatusNet, Inc.
  15  *
  16  * This program is free software: you can redistribute it and/or modify
  17  * it under the terms of the GNU Affero General Public License as published by
  18  * the Free Software Foundation, either version 3 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
  24  * GNU Affero General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU Affero General Public License
  27  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 class Yammer_state extends Memcached_DataObject
  35 {
  36     public $__table = 'yammer_state'; // table name
  37     public $id;                       // int  primary_key not_null
  38     public $state;                    // import state key
  39     public $request_token;            // oauth request token; clear when auth is complete.
  40     public $oauth_token;              // actual oauth token! clear when import is done?
  41     public $users_page;               // last page of users we've fetched
  42     public $groups_page;              // last page of groups we've fetched
  43     public $messages_oldest;          // oldest message ID we've fetched
  44     public $messages_newest;          // newest message ID we've imported
  45     public $created;                  // datetime
  46     public $modified;                 // datetime
  47
  48     /**
  49      * Return schema definition to set this table up in onCheckSchema
  50      */
  51     static function schemaDef()
  52     {
  53         return array(new ColumnDef('id', 'int', null,
  54                                    false, 'PRI'),
  55                      new ColumnDef('state', 'text'),
  56                      new ColumnDef('request_token', 'text'),
  57                      new ColumnDef('oauth_token', 'text'),
  58                      new ColumnDef('users_page', 'int'),
  59                      new ColumnDef('groups_page', 'int'),
  60                      new ColumnDef('messages_oldest', 'bigint'),
  61                      new ColumnDef('messages_newest', 'bigint'),
  62                      new ColumnDef('created', 'datetime'),
  63                      new ColumnDef('modified', 'datetime'));
  64     }
  65
  66     /**
  67      * return table definition for DB_DataObject
  68      *
  69      * DB_DataObject needs to know something about the table to manipulate
  70      * instances. This method provides all the DB_DataObject needs to know.
  71      *
  72      * @return array array of column definitions
  73      */
  74
  75     function table()
  76     {
  77         return array('id'              => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
  78                      'state'           => DB_DATAOBJECT_STR,
  79                      'request_token'   => DB_DATAOBJECT_STR,
  80                      'oauth_token'     => DB_DATAOBJECT_STR,
  81                      'users_page'      => DB_DATAOBJECT_INT,
  82                      'groups_page'     => DB_DATAOBJECT_INT,
  83                      'messages_oldest' => DB_DATAOBJECT_INT,
  84                      'messages_newest' => DB_DATAOBJECT_INT,
  85                      'created'         => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
  86     }
  87
  88     /**
  89      * return key definitions for DB_DataObject
  90      *
  91      * DB_DataObject needs to know about keys that the table has, since it
  92      * won't appear in StatusNet's own keys list. In most cases, this will
  93      * simply reference your keyTypes() function.
  94      *
  95      * @return array list of key field names
  96      */
  97
  98     function keys()
  99     {
 100         return array_keys($this->keyTypes());
 101     }
 102
 103     /**
 104      * return key definitions for Memcached_DataObject
 105      *
 106      * Our caching system uses the same key definitions, but uses a different
 107      * method to get them. This key information is used to store and clear
 108      * cached data, so be sure to list any key that will be used for static
 109      * lookups.
 110      *
 111      * @return array associative array of key definitions, field name to type:
 112      *         'K' for primary key: for compound keys, add an entry for each component;
 113      *         'U' for unique keys: compound keys are not well supported here.
 114      */
 115
 116     function keyTypes()
 117     {
 118         return array('id' => 'K');
 119     }
 120
 121     /**
 122      * Magic formula for non-autoincrementing integer primary keys
 123      *
 124      * If a table has a single integer column as its primary key, DB_DataObject
 125      * assumes that the column is auto-incrementing and makes a sequence table
 126      * to do this incrementation. Since we don't need this for our class, we
 127      * overload this method and return the magic formula that DB_DataObject needs.
 128      *
 129      * @return array magic three-false array that stops auto-incrementing.
 130      */
 131
 132     function sequenceKey()
 133     {
 134         return array(false, false, false);
 135     }
 136 }