File Editor

Directories:

.. (Back)

Files:

Create New File

Edit File: Plugin_Info.php

<?php
/**
 * Plugin Info Class
 *
 * This is a direct port to Tribe Commons of the PUE classes contained
 * in The Events Calendar.
 *
 * @todo switch all plugins over to use the PUE utilities here in Commons
 */

// Don't load directly
if ( ! defined( 'ABSPATH' ) ) {
	die( '-1' );
}

if ( ! class_exists( 'Tribe__PUE__Plugin_Info' ) ) {
	/**
	 * A container class for holding and transforming various plugin metadata.
	 * @version 1.7
	 * @access public
	 */
	class Tribe__PUE__Plugin_Info {
		// Most fields map directly to the contents of the plugin's info.json file.
		public $name;
		public $plugin;
		public $slug;
		public $version;
		public $homepage;
		public $sections;
		public $download_url;
		public $home_url;
		public $origin_url;
		public $zip_url;
		public $icon_svg_url;
		public $file_prefix;

public $author;
		public $author_homepage;

public $requires;
		public $tested;
		public $upgrade_notice;

public $rating;
		public $num_ratings;
		public $downloaded;
		public $release_date;
		public $last_updated;
		public $expiration;
		public $daily_limit;
		public $custom_update;

public $api_expired;
		public $api_invalid;
		public $api_upgrade;
		public $api_message;
		public $api_inline_invalid_message;
		public $api_invalid_message;

public $license_error;

public $new_install_key;
		public $replacement_key;

public $id = 0; // The native WP.org API returns numeric plugin IDs, but they're not used for anything.

/**
		 * Create a new instance of Tribe__PUE__Plugin_Info from JSON-encoded plugin info
		 * returned by an external update API.
		 *
		 * @param string $json Valid JSON string representing plugin info.
		 *
		 *@return Tribe__PUE__Plugin_Info New instance of Tribe__PUE__Plugin_Info, or NULL on error.
		 */
		public static function from_json( $json ) {
			$apiResponse = json_decode( $json );

// Get first item of the response array
			if ( $apiResponse && ! empty( $apiResponse->results ) ) {
				$apiResponse = current( $apiResponse->results );
			}

if ( empty( $apiResponse ) || ! is_object( $apiResponse ) ) {
				return null;
			}

//Very, very basic validation.
			$valid = ( isset( $apiResponse->name ) && ! empty( $apiResponse->name ) && isset( $apiResponse->version ) && ! empty( $apiResponse->version ) ) || ( isset( $apiResponse->api_invalid ) || isset( $apiResponse->no_api ) );
			if ( ! $valid ) {
				return null;
			}

$info = new Tribe__PUE__Plugin_Info();

foreach ( get_object_vars( $apiResponse ) as $key => $value ) {
				$key = str_replace( 'plugin_', '', $key ); // let's strip out the "plugin_" prefix we've added in plugin-updater-classes.
				$info->$key = $value;
			}

return $info;
		}

/**
		 * Transform plugin info into the format used by the native WordPress.org API
		 *
		 * @return object
		 */
		public function to_wp_format() {
			$info = new StdClass;

// The custom update API is built so that many fields have the same name and format
			// as those returned by the native WordPress.org API. These can be assigned directly.
			$sameFormat = [
				'name',
				'slug',
				'version',
				'requires',
				'tested',
				'rating',
				'upgrade_notice',
				'num_ratings',
				'downloaded',
				'homepage',
				'last_updated',
				'api_expired',
				'api_upgrade',
				'api_invalid',
			];

foreach ( $sameFormat as $field ) {
				if ( isset( $this->$field ) ) {
					$info->$field = $this->$field;
				} else {
					$info->$field = null;
				}
			}

//Other fields need to be renamed and/or transformed.
			$info->download_link = $this->download_url;

if ( ! empty( $this->author_homepage ) ) {
				$info->author = sprintf( '<a href="%s">%s</a>', esc_url( $this->author_homepage ), $this->author );
			} else {
				$info->author = $this->author;
			}

if ( is_object( $this->sections ) ) {
				$info->sections = get_object_vars( $this->sections );
			} elseif ( is_array( $this->sections ) ) {
				$info->sections = $this->sections;
			} else {
				$info->sections = [ 'description' => '' ];
			}

return $info;
		}
	}
}

File Editor

Directories:

Files:

Create New File

Edit File: Plugin_Info.php

Rename File