fetch-tweets.php

<?php
/** 
 *  Plugin Name:    Fetch Tweets
 *  Plugin URI:     http://en.michaeluno.jp/fetch-tweets
 *  Description:    Fetches and displays tweets from twitter.com with the the Twitter REST API v1.1.
 *  Author:         miunosoft (Michael Uno)
 *  Author URI:     http://michaeluno.jp
 *  Version:        2.6.4
 *  Requirements:   PHP 5.2.4 or above, WordPress 3.3 or above.
 */

/**
 * Provides the basic information about the plugin.
 * 
 * @since       2.3.5
 */
class FetchTweets_Commons_Base {
    
	const VERSION        = '2.6.4';    // <--- DON'T FORGET TO CHANGE THIS AS WELL!!
	const NAME           = 'Fetch Tweets';
	const DESCRIPTION    = 'Fetches and displays tweets from twitter.com with the the Twitter REST API v1.1.';
	const URI            = 'http://en.michaeluno.jp/fetch-tweets';
	const AUTHOR         = 'miunosoft (Michael Uno)';
	const AUTHOR_URI     = 'http://en.michaeluno.jp/';
	const COPYRIGHT      = 'Copyright (c) 2013-2015, Michael Uno';
	const LICENSE        = 'GPL v2 or later';
	const CONTRIBUTORS   = '';
    
    /**
     * Returns the information of this class.
     * 
     * @since       2.4.2
     */
    static public function getInfo() {
        $_oReflection = new ReflectionClass( __CLASS__ );
        return $_oReflection->getConstants()
            + $_oReflection->getStaticProperties()
        ;
    }        
    
}

final class FetchTweets_Commons extends FetchTweets_Commons_Base {
	
	static public $sFilePath            = '';       // 2.3.5+
	static public $sDirPath             = '';       // 2.3.5+
	public static $sPluginKey           = 'fetch_tweets';          // unknown what this is used for.
	public static $sAdminKey            = 'fetch_tweets_admin';    // also the below 'AdminOptionKey' constant is being used.
	// public static $sOptionKey           = 'fetch_tweets_option';   // not used at the moment.
	
	// The below properties will be assigned automatically
    public static $sPluginPath          = '';
	public static $sPluginDirPath       = '';   // will be deprecated
	public static $sPluginName          = '';   // will be deprecated
	public static $sPluginURI           = '';   // deprecated
	public static $sPluginVersion       = '';   // will be deprecated
	public static $sPluginDescription   = '';   // will be deprecated
	public static $sPluginAuthor        = '';   // will be deprecated
	public static $sPluginAuthorURI     = '';   // will be deprecated
	public static $sPluginTextDomain    = '';   // will be deprecated
	public static $sPluginDomainPath    = '';   // will be deprecated
	public static $sPluginNetwork       = '';   // deprecated
	public static $sPluginSiteWide      = '';   // deprecated
	public static $sPluginStoreURI      = '';   // will be deprecated
	
	const TEXT_DOMAIN                   = 'fetch-tweets';
    const TEXT_DOMAIN_PATH              = '/languange';

    /**
     * Stores the main post type slug.
     * @remark      Some extensions access this class constant.
     * @remark      Use the `$aPosTypes['main']` static property. This is kept for backward compatibility.
     * @deprecated
     */
	const PostTypeSlug                  = 'fetch_tweets';   
    
    /**
     * 
     * @since       2.4.7
     * @remark      post type slugs cannot exceed 20 characters. 
     */
    public static $aPostTypes = array(
        'main'      => 'fetch_tweets',
        'account'   => 'fetchtweets_accounts',
    );
    
    /**
     * The plugin main taxonomy slug.
     * 
     * @remark      Some extensions access this value.
     */
	const TagSlug                       = 'fetch_tweets_tag';
    
    /**
     * The plugin option key.
     * 
     * @remark      Some extensions access this value.
     */
	const AdminOptionKey                = 'fetch_tweets_admin';
    
    /**
     * The plugin setting page slug.
     * @remark      Some extensions access this value.
     */
	const PageSettingsSlug              = 'fetch_tweets_settings';
    
    /**
     * Stores page slugs.
     * @since       2.4.7
     */
    static public $aPageSlugs = array(
        'template' => 'fetch_tweets_templates',
    );
    
    /**
     * The plugin transient prefix.
     * @remark      Accessed from some extensions.
     */
	const TransientPrefix               = 'FTWS';
    
    /**
     * 
     * @remark      Accessed from some extensions.
     */
	const ConsumerKey                   = '97LqHiMs06VhV2rf5tUQw';
	const ConsumerSecret                = 'FIH9cr0eXtd7q9caYVqBjd5mvfUS6hZqREYsUhh9wA';
    
    /**
     * 
     * @deprecated      2.4.7
     */
    // const PrimaryTaxonomySlug           = 'fetch_tweets_tag';
	
	static public function setUp( $sPluginFilePath ) {
		
        self::$sFilePath            = $sPluginFilePath;             // 2.3.5+
        self::$sDirPath             = dirname( $sPluginFilePath );  // 2.3.5+
        
		// These static properties are for backward compatibility.
        self::$sPluginPath          = $sPluginFilePath;             // backward compat
        self::$sPluginDirPath       = self::$sDirPath;              // backward compat
        self::$sPluginName          = self::NAME;
        self::$sPluginVersion       = self::VERSION;
        self::$sPluginDescription   = self::DESCRIPTION;
        self::$sPluginAuthor        = self::AUTHOR;
        self::$sPluginAuthorURI     = self::AUTHOR_URI;
        self::$sPluginStoreURI      = 'http://michaeluno.jp';
        self::$sPluginTextDomain    = self::TEXT_DOMAIN;
        self::$sPluginDomainPath    = self::TEXT_DOMAIN_PATH;
        
	}
	
	public static function getPluginKey() {
		return self::$sPluginKey;
	}
	public static function getAdminKey() {
		return self::$sAdminKey;
	}
	public static function getOptionKey() {
		return self::$sOptionKey;
	}	
	public static function getPluginFilePath() {
		return self::$sPluginPath;
	} 
	public static function getPluginDirPath() {
		return dirname( self::$sPluginPath );
	}
	public static function getPluginURL( $sRelativePath='' ) {
		return plugins_url( $sRelativePath, self::$sPluginPath );
	}    
    
    /**
     * Requirements.
     * @since       2.5.0
     */    
    static public $aRequirements = array(
        'php' => array(
            'version'   => '5.2.4',
            'error'     => 'The plugin requires the PHP version %1$s or higher.',
        ),
        'wordpress'         => array(
            'version'   => '3.4',
            'error'     => 'The plugin requires the WordPress version %1$s or higher.',
        ),
        'mysql'             => array(
            'version'   => '5.0',
            'error'     => 'The plugin requires the MySQL version %1$s or higher.',
        ),
        'functions' => array(
            'curl_version' => 'The plugin requires the cURL library to be installed.',
        ),
        // array(
            // e.g. 'mblang' => 'The plugin requires the mbstring extension.',
        // ),
        'classes'           => '', // disabled
        // array(
            // e.g. 'DOMDocument' => 'The plugin requires the DOMXML extension.',
        // ),
        'constants'         => '', // disabled
        // array(
            // e.g. 'THEADDONFILE' => 'The plugin requires the ... addon to be installed.',
            // e.g. 'APSPATH' => 'The script cannot be loaded directly.',
        // ),
        'files'             => '', // disabled
        // array(
            // e.g. 'home/my_user_name/my_dir/scripts/my_scripts.php' => 'The required script could not be found.',
        // ),
    );
	
    /**
     * Stores custom database table names.
     * @remark      The below is the structure
     * array(
     *      'slug (part of database wrapper class file name)' => array(
     *          'version'   => '0.1',
     *          'name'      => 'table_name',    // serves as the table name suffix
     *      ),
     *      ...
     * )
     * @since       2.5.0
     */
    static public $aDatabaseTables = array(
        // 'ft_tweets'        => array(
            // 'name'              => 'ft_tweets', // serves as the table name suffix
            // 'version'           => '0.0.1',
            // 'across_network'    => true,
            // 'class_name'        => 'FetchTweets_DatabaseTable_ft_tweets',
        // ),
        'ft_http_requests' => array(
            'name'              => 'ft_http_requests',  // serves as the table name suffix
            'version'           => '0.0.1',
            'across_network'    => true,
            'class_name'        => 'FetchTweets_DatabaseTable_ft_http_requests',
        ),
    );
    
    /**
     * Stores the database table versions.
     * @since       3
     * @deprecated
     */
    // static public $aDatabaseTableVersions = array(
        // 'product'       => '1.0.0',
        // 'request_cache' => '1.0.0',
    // );    
    
}
FetchTweets_Commons::setUp( __FILE__ );

// Do not load if accessed directly. Not exiting here because other scripts will load this main file such as uninstall.php and inclusion list generator 
// and if it exists their scripts will not complete.
if ( ! defined( 'ABSPATH' ) ) { 
    return; 
}

include( dirname( __FILE__ ). '/include/library/apf/admin-page-framework.php' );
include( dirname( __FILE__ ). '/include/FetchTweets_Bootstrap.php' );
new FetchTweets_Bootstrap( 
    __FILE__,       // the plugin main file path
    'fetch_tweets'  // hook prefix (without underscore)
);