Event::image_full() - Code Metrics - Inspection of "Daily Inspection: Merge remote-tracking branch 'or..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — BUG-9464-payment-methods-myste... (4799f5)

unknown

created 2016-03-13 21:58 UTC

Event::image_full() A

↳ Parent: Event

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	3
rs	10
cc	1
eloc	2
nc	1
nop	3

<?php
namespace EventEspresso\core\libraries\rest_api\calculations;

use EventEspresso\core\libraries\rest_api\calculations\Base as Calculations_Base;
use EventEspresso\core\libraries\rest_api\controllers\model\Base;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
/**
 *
 * Class Event_Calculations
 *
 * Description here
 *
 * @package         Event Espresso
 * @subpackage
 * @author				Mike Nelson
 * @since		 	   $VID:$
 *
 */
if( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
	exit( 'No direct script access allowed' );
}

class Event extends Calculations_Base {

	/**
	 * Calculates the total spaces on the event (not subtracting sales, but taking
	 * sales into account; so this is the optimum sales that CAN still be achieved)
	 * See EE_Event::total_available_spaces( true );
	 *
	 * @param array            $wpdb_row
	 * @param \WP_REST_Request $request
	 * @param Base             $controller
	 * @return int
	 * @throws \EE_Error
	 */
	public static function optimum_sales_at_start( $wpdb_row, $request, $controller ){

		if( is_array( $wpdb_row ) && isset( $wpdb_row[ 'Event_CPT.ID' ] ) ) {
			$event_obj = \EEM_Event::instance()->get_one_by_ID( $wpdb_row[ 'Event_CPT.ID' ] );
		} else {
			$event_obj = null;
		}
		if( $event_obj instanceof \EE_Event ) {
			return $event_obj->total_available_spaces( true );
		} else {
			throw new \EE_Error(
				sprintf(
					__( 'Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found', 'event_espresso' ),
					$wpdb_row[ 'Event_CPT.ID' ],
					print_r( $wpdb_row, true )
				)
			);
		}
	}



	/**
	 * Calculates the total spaces on the event (ignoring all sales; so this is the optimum
	 * sales that COULD have been achieved)
	 * See EE_Event::total_available_spaces( true );
	 *
	 * @param array            $wpdb_row
	 * @param \WP_REST_Request $request
	 * @param Base             $controller
	 * @return int
	 * @throws \EE_Error
	 */
	public static function optimum_sales_now( $wpdb_row, $request, $controller ){

		if( is_array( $wpdb_row ) && isset( $wpdb_row[ 'Event_CPT.ID' ] ) ) {
			$event_obj = \EEM_Event::instance()->get_one_by_ID( $wpdb_row[ 'Event_CPT.ID' ] );
		} else {
			$event_obj = null;
		}
		if( $event_obj instanceof \EE_Event ) {
			return $event_obj->total_available_spaces( false );
		} else {
			throw new \EE_Error(
				sprintf(
					__( 'Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found', 'event_espresso' ),
					$wpdb_row[ 'Event_CPT.ID' ],
					print_r( $wpdb_row, true )
				)
			);
		}
	}



	/**
	 * Like optimum_sales_now, but minus total sales so far.
	 * See EE_Event::spaces_remaining_for_sale( true );
	 *
	 * @param array            $wpdb_row
	 * @param \WP_REST_Request $request
	 * @param Base             $controller
	 * @return int
	 * @throws \EE_Error
	 */
	public static function spaces_remaining( $wpdb_row, $request, $controller ){

		if( is_array( $wpdb_row ) && isset( $wpdb_row[ 'Event_CPT.ID' ] ) ) {
			$event_obj = \EEM_Event::instance()->get_one_by_ID( $wpdb_row[ 'Event_CPT.ID' ] );
		} else {
			$event_obj = null;
		}
		if( $event_obj instanceof \EE_Event ) {
			return $event_obj->spaces_remaining_for_sale();
		} else {
			throw new \EE_Error(
				sprintf(
					__( 'Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found', 'event_espresso' ),
					$wpdb_row[ 'Event_CPT.ID' ],
					print_r( $wpdb_row, true )
				)
			);
		}
	}



	/**
	 * Counts the number of approved registrations for this event (regardless
	 * of how many datetimes each registrations' ticket purchase is for)
	 *
	 * @param array            $wpdb_row
	 * @param \WP_REST_Request $request
	 * @param Base             $controller
	 * @return int
	 * @throws \EE_Error
	 */
	public static function spots_taken( $wpdb_row, $request, $controller ){

		if( ! is_array( $wpdb_row ) || ! isset( $wpdb_row[ 'Event_CPT.ID' ] ) ) {
			throw new \EE_Error(
				sprintf(
					__( 'Cannot calculate spots_taken because the database row %1$s does not have an entry for "Event_CPT.ID"', 'event_espresso' ),
					print_r( $wpdb_row, true )
				)
			);
		}
		return \EEM_Registration::instance()->count(
			array(
				array(
					'EVT_ID' => $wpdb_row[ 'Event_CPT.ID' ],
					'STS_ID' => \EEM_Registration::status_id_approved
				)
			),
			'REG_ID',
			true
		);
	}



	/**
	 * Counts the number of pending-payment registrations for this event (regardless
	 * of how many datetimes each registrations' ticket purchase is for)
	 *
	 * @param array            $wpdb_row
	 * @param \WP_REST_Request $request
	 * @param Base             $controller
	 * @return int
	 * @throws \EE_Error
	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
	 */
	public static function spots_taken_pending_payment( $wpdb_row, $request, $controller ){

		if( ! is_array( $wpdb_row ) || ! isset( $wpdb_row[ 'Event_CPT.ID' ] ) ) {
			throw new \EE_Error(
				sprintf(
					__( 'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"', 'event_espresso' ),
					print_r( $wpdb_row, true )
				)
			);
		}
		self::_verify_current_user_can( 'ee_read_registrations', 'spots_taken_pending_payment' );
		return \EEM_Registration::instance()->count(
			array(
				array(
					'EVT_ID' => $wpdb_row[ 'Event_CPT.ID' ],
					'STS_ID' => \EEM_Registration::status_id_pending_payment
				)
			),
			'REG_ID',
			true
		);
	}



	/**
	 * Counts all the registrations who have checked into one of this events' datetimes
	 * See EE_Event::total_available_spaces( false );
	 *
	 * @param array            $wpdb_row
	 * @param \WP_REST_Request $request
	 * @param Base             $controller
	 * @return int|null if permission denied
	 * @throws \EE_Error
	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
	 */
	public static function registrations_checked_in_count( $wpdb_row, $request, $controller ){

		if( ! is_array( $wpdb_row ) || ! isset( $wpdb_row[ 'Event_CPT.ID' ] ) ) {
			throw new \EE_Error(
				sprintf(
					__( 'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"', 'event_espresso' ),
					print_r( $wpdb_row, true )
				)
			);
		}
		self::_verify_current_user_can( 'ee_read_checkins', 'registrations_checked_in_count' );
		return \EEM_Registration::instance()->count_registrations_checked_into_event( $wpdb_row[ 'Event_CPT.ID' ], true );
	}



	/**
	 * Counts all the registrations who have checked out of one of this events' datetimes
	 * See EE_Event::total_available_spaces( false );
	 *
	 * @param array            $wpdb_row
	 * @param \WP_REST_Request $request
	 * @param Base             $controller
	 * @return int
	 * @throws \EE_Error
	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
	 */
	public static function registrations_checked_out_count( $wpdb_row, $request, $controller ){

		if( ! is_array( $wpdb_row ) || ! isset( $wpdb_row[ 'Event_CPT.ID' ] ) ) {
			throw new \EE_Error(
				sprintf(
					__( 'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"', 'event_espresso' ),
					print_r( $wpdb_row, true )
				)
			);
		}
		self::_verify_current_user_can( 'ee_read_checkins', 'registrations_checked_out_count' );
		return \EEM_Registration::instance()->count_registrations_checked_into_event( $wpdb_row[ 'Event_CPT.ID' ], false );
	}

	/**
	 * Gets the thumbnail image
	 * @param array $wpdb_row
	 * @param \WP_REST_Request $request
	 * @param Base $controller
	 * @return array
	 */
	public static function image_thumbnail( $wpdb_row, $request, $controller ) {

		return self::_calculate_image_data($wpdb_row[ 'Event_CPT.ID' ], 'thumbnail' );
	}

	/**
	 * Gets the medium image
	 * @param array $wpdb_row
	 * @param \WP_REST_Request $request
	 * @param Base $controller
	 * @return array
	 */
	public static function image_medium( $wpdb_row, $request, $controller ) {

		return self::_calculate_image_data($wpdb_row[ 'Event_CPT.ID' ], 'medium' );
	}

	/**
	 * Gets the medium-large image
	 * @param array $wpdb_row
	 * @param \WP_REST_Request $request
	 * @param Base $controller
	 * @return array
	 */
	public static function image_medium_large( $wpdb_row, $request, $controller ) {

		return self::_calculate_image_data($wpdb_row[ 'Event_CPT.ID' ], 'medium_large' );
	}

	/**
	 * Gets the large image
	 * @param array $wpdb_row
	 * @param \WP_REST_Request $request
	 * @param Base $controller
	 * @return array
	 */
	public static function image_large( $wpdb_row, $request, $controller ) {

		return self::_calculate_image_data($wpdb_row[ 'Event_CPT.ID' ], 'large' );
	}

	/**
	 * Gets the post-thumbnail image
	 * @param array $wpdb_row
	 * @param \WP_REST_Request $request
	 * @param Base $controller
	 * @return array
	 */
	public static function image_post_thumbnail( $wpdb_row, $request, $controller ) {

		return self::_calculate_image_data($wpdb_row[ 'Event_CPT.ID' ], 'post-thumbnail' );
	}

	/**
	 * Gets the full size image
	 * @param array $wpdb_row
	 * @param \WP_REST_Request $request
	 * @param Base $controller
	 * @return array
	 */
	public static function image_full( $wpdb_row, $request, $controller ) {

		return self::_calculate_image_data($wpdb_row[ 'Event_CPT.ID' ], 'full' );
	}

	/**
	 * Gets image specs and formats them for the display in the API,
	 * according to the image size requested
	 * @param int $EVT_ID
	 * @param string $image_size one of these: thumbnail, medium, medium_large, large, post-thumbnail, full
	 * @return array|false if no such image exists. If array it will have keys 'url', 'width', 'height' and 'original'
	 */
	protected static function _calculate_image_data( $EVT_ID, $image_size ) {
		$attachment_id = get_post_thumbnail_id( $EVT_ID );
		$data = wp_get_attachment_image_src( $attachment_id, $image_size );
		if( ! $data ) {
			return false;
		}
		if( isset( $data[ 3] ) ) {
			$generated = $data[ 3 ];
		} else {
			$generated = true;
		}
		return array(
			'url' => $data[ 0 ],
			'width' => $data[ 1 ],
			'height' => $data[ 2 ],
			'generated' => $generated
		);
	}
}


1		<?php
2		namespace EventEspresso\core\libraries\rest_api\calculations;
3
4		use EventEspresso\core\libraries\rest_api\calculations\Base as Calculations_Base;
5		use EventEspresso\core\libraries\rest_api\controllers\model\Base;
		0 ignored issues – show Bug introduced 2016-03-04 10:28 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `EventEspresso\core\libra...t_api\calculations\Base`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
6		/**
7		*
8		* Class Event_Calculations
9		*
10		* Description here
11		*
12		* @package Event Espresso
13		* @subpackage
14		* @author Mike Nelson
15		* @since $VID:$
16		*
17		*/
18		if( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
19		exit( 'No direct script access allowed' );
20		}
21
22		class Event extends Calculations_Base {
23
24		/**
25		* Calculates the total spaces on the event (not subtracting sales, but taking
26		* sales into account; so this is the optimum sales that CAN still be achieved)
27		* See EE_Event::total_available_spaces( true );
28		*
29		* @param array $wpdb_row
30		* @param \WP_REST_Request $request
31		* @param Base $controller
32		* @return int
33		* @throws \EE_Error
34		*/
35	View Code Duplication	public static function optimum_sales_at_start( $wpdb_row, $request, $controller ){
		0 ignored issues – show Unused Code introduced 2016-02-25 14:41 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-02-25 14:41 UTC by Report Bug Copy Issue Report The parameter `$controller` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Duplication introduced 2016-03-03 10:14 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
36		if( is_array( $wpdb_row ) && isset( $wpdb_row[ 'Event_CPT.ID' ] ) ) {
37		$event_obj = \EEM_Event::instance()->get_one_by_ID( $wpdb_row[ 'Event_CPT.ID' ] );
38		} else {

eventespresso / event-espresso-core

Branch — BUG-9464-payment-methods-myste... (4799f5)

Event::image_full() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like