431 lines
13 KiB
PHP
431 lines
13 KiB
PHP
<?php
|
|
/**
|
|
* @brief Coupon Node
|
|
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
|
|
* @copyright (c) Invision Power Services, Inc.
|
|
* @license https://www.invisioncommunity.com/legal/standards/
|
|
* @package Invision Community
|
|
* @subpackage Nexus
|
|
* @since 11 Mar 2014
|
|
*/
|
|
|
|
namespace IPS\nexus;
|
|
|
|
/* To prevent PHP errors (extending class does not exist) revealing path */
|
|
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
|
{
|
|
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* Coupon Node
|
|
*/
|
|
class _Coupon extends \IPS\Node\Model
|
|
{
|
|
/**
|
|
* @brief [ActiveRecord] Multiton Store
|
|
*/
|
|
protected static $multitons;
|
|
|
|
/**
|
|
* @brief [ActiveRecord] Database Table
|
|
*/
|
|
public static $databaseTable = 'nexus_coupons';
|
|
|
|
/**
|
|
* @brief [ActiveRecord] Database Prefix
|
|
*/
|
|
public static $databasePrefix = 'c_';
|
|
|
|
/**
|
|
* @brief [Node] Node Title
|
|
*/
|
|
public static $nodeTitle = 'menu__nexus_store_coupons';
|
|
|
|
/**
|
|
* @brief [ActiveRecord] Database ID Fields
|
|
*/
|
|
protected static $databaseIdFields = array( 'c_code' );
|
|
|
|
/**
|
|
* @brief [ActiveRecord] Multiton Map
|
|
*/
|
|
protected static $multitonMap = array();
|
|
|
|
/**
|
|
* @brief [Node] ACP Restrictions
|
|
* @code
|
|
array(
|
|
'app' => 'core', // The application key which holds the restrictrions
|
|
'module' => 'foo', // The module key which holds the restrictions
|
|
'map' => array( // [Optional] The key for each restriction - can alternatively use "prefix"
|
|
'add' => 'foo_add',
|
|
'edit' => 'foo_edit',
|
|
'permissions' => 'foo_perms',
|
|
'delete' => 'foo_delete'
|
|
),
|
|
'all' => 'foo_manage', // [Optional] The key to use for any restriction not provided in the map (only needed if not providing all 4)
|
|
'prefix' => 'foo_', // [Optional] Rather than specifying each key in the map, you can specify a prefix, and it will automatically look for restrictions with the key "[prefix]_add/edit/permissions/delete"
|
|
* @endcode
|
|
*/
|
|
protected static $restrictions = array(
|
|
'app' => 'nexus',
|
|
'module' => 'store',
|
|
'prefix' => 'coupons_',
|
|
);
|
|
|
|
/**
|
|
* [Node] Get title
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function get__title()
|
|
{
|
|
return $this->code;
|
|
}
|
|
|
|
/**
|
|
* [Node] Add/Edit Form
|
|
*
|
|
* @param \IPS\Helpers\Form $form The form
|
|
* @return void
|
|
*/
|
|
public function form( &$form )
|
|
{
|
|
$groups = array();
|
|
foreach ( \IPS\Member\Group::groups() as $group )
|
|
{
|
|
$groups[ $group->g_id ] = $group->name;
|
|
}
|
|
|
|
if ( $this->id and $this->products !== '*' )
|
|
{
|
|
$products = array();
|
|
foreach ( explode( ',', $this->products ) as $packageId )
|
|
{
|
|
try
|
|
{
|
|
$products[] = \IPS\nexus\Package::load( $packageId );
|
|
}
|
|
catch ( \OutOfRangeException $e ) { }
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$products = 0;
|
|
}
|
|
|
|
|
|
$form->addHeader( 'coupon_basic_settings' );
|
|
$id = $this->id ?: NULL;
|
|
$form->add( new \IPS\Helpers\Form\Text( 'c_code', $this->id ? $this->code : mb_strtoupper( mb_substr( md5( uniqid() ), 0, 5 ) ), TRUE, array( 'maxLength' => 25 ), function( $val ) use ( $id )
|
|
{
|
|
try
|
|
{
|
|
$coupon = \IPS\nexus\Coupon::load( $val, 'c_code' );
|
|
if ( $coupon->id AND $coupon->id != $id )
|
|
{
|
|
throw new \DomainException('c_code_err');
|
|
}
|
|
}
|
|
catch ( \OutOfRangeException $e ) {}
|
|
} ) );
|
|
$form->add( new \IPS\Helpers\Form\Radio( 'c_unit', $this->id ? $this->unit : 'v', TRUE, array( 'options' => array( 'v' => 'c_unit_v', 'p' => 'c_unit_p' ), 'toggles' => array( 'v' => array( 'c_discount_v' ), 'p' => array( 'c_discount_p', 'c_limit_discount' ) ) ) ) );
|
|
$form->add( new \IPS\nexus\Form\Money( 'c_discount_v', $this->unit === 'v' ? $this->discount : NULL, NULL, array(), function( $val )
|
|
{
|
|
if ( !$val and \IPS\Request::i()->c_unit === 'v' )
|
|
{
|
|
throw new \DomainException('form_required');
|
|
}
|
|
}, NULL, NULL, 'c_discount_v' ) );
|
|
$form->add( new \IPS\Helpers\Form\Number( 'c_discount_p', $this->unit === 'p' ? $this->discount : NULL, NULL, array( 'max' => 100 ), function( $val )
|
|
{
|
|
if ( !$val and \IPS\Request::i()->c_unit === 'p' )
|
|
{
|
|
throw new \DomainException('form_required');
|
|
}
|
|
}, NULL, '%', 'c_discount_p' ) );
|
|
|
|
$form->addHeader( 'coupon_products' );
|
|
$form->add( new \IPS\Helpers\Form\Node( 'c_products', $products, FALSE, array( 'class' => 'IPS\nexus\Package\Group', 'multiple' => TRUE, 'zeroVal' => 'no_restriction', 'zeroValTogglesOff' => array( 'c_renewals' ), 'permissionCheck' => function( $node )
|
|
{
|
|
return !( $node instanceof \IPS\nexus\Package\Group );
|
|
} ) ) );
|
|
$form->add( new \IPS\Helpers\Form\YesNo( 'c_renewals', $this->renewals ?: FALSE, FALSE, array(), NULL, NULL, NULL, 'c_renewals' ) );
|
|
$form->add( new \IPS\Helpers\Form\Radio( 'c_limit_discount', $this->limit_discount, FALSE, array( 'options' => array( 0 => 'c_limit_discount_no', 1 => 'c_limit_discount_yes' ) ), NULL, NULL, NULL, 'c_limit_discount' ) );
|
|
|
|
$form->addHeader( 'coupon_dates' );
|
|
$form->add( new \IPS\Helpers\Form\Date( 'c_start', $this->id ? $this->start : \IPS\DateTime::ts( time() ), TRUE, array( 'time' => TRUE ) ) );
|
|
$form->add( new \IPS\Helpers\Form\Date( 'c_end', $this->id ? $this->end : 0, FALSE, array( 'time' => TRUE, 'unlimited' => 0, 'unlimitedLang' => 'no_end_date' ) ) );
|
|
|
|
$form->addHeader( 'coupon_restrictions' );
|
|
$form->add( new \IPS\Helpers\Form\YesNo( 'c_combine', $this->combine ) );
|
|
$form->add( new \IPS\Helpers\Form\Number( 'c_uses', $this->id ? $this->uses : -1, FALSE, array( 'unlimited' => -1 ) ) );
|
|
$form->add( new \IPS\Helpers\Form\Number( 'c_member_uses', $this->id ? $this->member_uses : 1, FALSE, array( 'unlimited' => -1 ) ) );
|
|
$form->add( new \IPS\Helpers\Form\Select( 'c_groups', ( $this->id and $this->groups !== '*' ) ? explode( ',', $this->groups ) : '*', FALSE, array( 'options' => $groups, 'multiple' => TRUE, 'unlimited' => '*' ) ) );
|
|
|
|
}
|
|
|
|
/**
|
|
* [Node] Format form values from add/edit form for save
|
|
*
|
|
* @param array $values Values from the form
|
|
* @return array
|
|
*/
|
|
public function formatFormValues( $values )
|
|
{
|
|
if( isset( $values['c_unit'] ) )
|
|
{
|
|
$values['c_discount'] = $values['c_unit'] === 'v' ? json_encode( $values['c_discount_v'] ) : $values['c_discount_p'];
|
|
|
|
unset( $values['c_discount_v'] );
|
|
unset( $values['c_discount_p'] );
|
|
}
|
|
|
|
if( isset( $values['c_products'] ) )
|
|
{
|
|
if ( $values['c_products'] )
|
|
{
|
|
$products = array();
|
|
foreach ( $values['c_products'] as $package )
|
|
{
|
|
$products[ $package->id ] = $package->id;
|
|
}
|
|
$values['c_products'] = implode( ',', $products );
|
|
}
|
|
else
|
|
{
|
|
$values['c_products'] = '*';
|
|
}
|
|
}
|
|
|
|
if( isset( $values['c_start'] ) )
|
|
{
|
|
$values['c_start'] = $values['c_start']->getTimestamp();
|
|
}
|
|
|
|
if( isset( $values['c_end'] ) )
|
|
{
|
|
$values['c_end'] = $values['c_end'] ? $values['c_end']->getTimestamp() : 0;
|
|
}
|
|
|
|
if( isset( $values['c_groups'] ) )
|
|
{
|
|
$values['c_groups'] = is_array( $values['c_groups'] ) ? implode( ',', $values['c_groups'] ) : '*';
|
|
}
|
|
|
|
return $values;
|
|
}
|
|
|
|
/**
|
|
* [Node] Get buttons to display in tree
|
|
* Example code explains return value
|
|
*
|
|
* @code
|
|
array(
|
|
array(
|
|
'icon' => 'plus-circle', // Name of FontAwesome icon to use
|
|
'title' => 'foo', // Language key to use for button's title parameter
|
|
'link' => \IPS\Http\Url::internal( 'app=foo...' ) // URI to link to
|
|
'class' => 'modalLink' // CSS Class to use on link (Optional)
|
|
),
|
|
... // Additional buttons
|
|
);
|
|
* @endcode
|
|
* @param string $url Base URL
|
|
* @param bool $subnode Is this a subnode?
|
|
* @return array
|
|
*/
|
|
public function getButtons( $url, $subnode=FALSE )
|
|
{
|
|
return array_merge( array(
|
|
'view' => array(
|
|
'icon' => 'search',
|
|
'title' => 'view_coupon_uses',
|
|
'link' => $url->setQueryString( array( 'do' => 'viewUses', 'id' => $this->id ) )
|
|
),
|
|
), parent::getButtons( $url, $subnode ) );
|
|
}
|
|
|
|
/**
|
|
* Use coupon
|
|
*
|
|
* @param \IPS\nexus\Invoice $invoice Invoice to use against
|
|
* @param \IPS\nexus\Customer $customer The customer using
|
|
* @return \IPS\nexus\extensions\nexus\Item\CouponDiscount
|
|
* @throws \DomainException
|
|
*/
|
|
public function useCoupon( \IPS\nexus\Invoice $invoice, \IPS\nexus\Customer $customer )
|
|
{
|
|
/* Restricted to groups? */
|
|
if ( $this->groups !== '*' )
|
|
{
|
|
$inGroup = FALSE;
|
|
foreach ( explode( ',', $this->groups ) as $groupId )
|
|
{
|
|
if ( $customer->inGroup( $groupId ) )
|
|
{
|
|
$inGroup = TRUE;
|
|
break;
|
|
}
|
|
}
|
|
if ( !$inGroup )
|
|
{
|
|
throw new \DomainException( 'coupon_not_in_group' );
|
|
}
|
|
}
|
|
|
|
/* Valid dates */
|
|
if ( $this->start and $this->start > time() )
|
|
{
|
|
throw new \DomainException( 'coupon_not_started' );
|
|
}
|
|
if ( $this->end and $this->end < time() )
|
|
{
|
|
throw new \DomainException( 'coupon_expired' );
|
|
}
|
|
|
|
/* Maximum uses? */
|
|
if ( $this->uses == 0 )
|
|
{
|
|
throw new \DomainException( 'coupon_expired' );
|
|
}
|
|
|
|
/* Maximum uses per member? */
|
|
$uses = $this->used_by ? json_decode( $this->used_by, TRUE ) : array();
|
|
$customerIdentifier = $customer->member_id ?: $invoice->guest_data['member']['email'];
|
|
if ( $this->member_uses != -1 )
|
|
{
|
|
if ( isset( $uses[ $customerIdentifier ] ) and $uses[ $customerIdentifier ] >= $this->member_uses )
|
|
{
|
|
throw new \DomainException( 'coupon_exceeded_member_uses' );
|
|
}
|
|
}
|
|
|
|
/* Use in conjunction with other coupons? */
|
|
foreach ( $invoice->items as $item )
|
|
{
|
|
if ( $item instanceof \IPS\nexus\extensions\nexus\Item\CouponDiscount )
|
|
{
|
|
if ( $item->id === $this->id )
|
|
{
|
|
throw new \DomainException( 'coupon_already_used' );
|
|
}
|
|
else
|
|
{
|
|
if ( !$this->combine )
|
|
{
|
|
throw new \DomainException( $customer->language()->addToStack( 'coupon_not_in_conjunction', FALSE, array( 'sprintf' => array( $this->code ) ) ) );
|
|
}
|
|
else
|
|
{
|
|
try
|
|
{
|
|
$otherCoupon = static::load( $item->id );
|
|
if ( !$otherCoupon->combine )
|
|
{
|
|
throw new \DomainException( $customer->language()->addToStack( 'coupon_not_in_conjunction', FALSE, array( 'sprintf' => array( $otherCoupon->code ) ) ) );
|
|
}
|
|
}
|
|
catch ( \OutOfRangeException $e ) { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/* Restricted to products? */
|
|
$items = NULL;
|
|
if ( $this->products !== '*' )
|
|
{
|
|
$allowedProductIds = explode( ',', $this->products );
|
|
$hasAllowedProduct = FALSE;
|
|
$productTotal = new \IPS\Math\Number('0');
|
|
|
|
$items = array();
|
|
|
|
foreach ( $invoice->items as $k => $item )
|
|
{
|
|
if ( $item instanceof \IPS\nexus\extensions\nexus\Item\Package and in_array( $item->id, $allowedProductIds ) )
|
|
{
|
|
$hasAllowedProduct = TRUE;
|
|
$productTotal = $productTotal->add( $item->price->amount->multiply( new \IPS\Math\Number("{$item->quantity}") ) );
|
|
|
|
$items[] = $k;
|
|
}
|
|
elseif ( $this->renewals and $item instanceof \IPS\nexus\Invoice\Item\Renewal )
|
|
{
|
|
try
|
|
{
|
|
$purchase = \IPS\nexus\Purchase::load( $item->id );
|
|
if ( $purchase->app == 'nexus' and $purchase->type == 'package' and in_array( $purchase->item_id, $allowedProductIds ) )
|
|
{
|
|
$hasAllowedProduct = TRUE;
|
|
$productTotal = $productTotal->add( $item->price->amount );
|
|
|
|
$items[] = $k;
|
|
}
|
|
}
|
|
catch ( \OutOfRangeException $e ) { }
|
|
}
|
|
}
|
|
|
|
if ( !$hasAllowedProduct )
|
|
{
|
|
throw new \DomainException( 'coupon_invalid_products' );
|
|
}
|
|
}
|
|
|
|
/* How much are we taking off? */
|
|
$discount = new \IPS\nexus\Money( 0, $invoice->currency );
|
|
if ( $this->unit === 'v' )
|
|
{
|
|
$prices = json_decode( $this->discount, TRUE );
|
|
if ( isset( $prices[ $invoice->currency ] ) )
|
|
{
|
|
$discount = new \IPS\nexus\Money( -$prices[ $invoice->currency ]['amount'], $invoice->currency );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if ( $this->limit_discount and isset( $productTotal ) )
|
|
{
|
|
$base = $productTotal;
|
|
}
|
|
else
|
|
{
|
|
$summary = $invoice->summary();
|
|
$base = $summary['subtotal']->amount;
|
|
}
|
|
|
|
$discount = new \IPS\nexus\Money( $base->percentage( new \IPS\Math\Number( $this->discount ) )->multiply( new \IPS\Math\Number( '-1' ) ), $invoice->currency );
|
|
}
|
|
|
|
/* Never allow a discount greater than the invoice total */
|
|
if ( $discount->amount->multiply( new \IPS\Math\Number( '-1' ) )->compare( $invoice->total->amount ) === 1 )
|
|
{
|
|
$discount = new \IPS\nexus\Money( $invoice->total->amount->multiply( new \IPS\Math\Number( '-1' ) ), $invoice->currency );
|
|
}
|
|
|
|
/* Save that we've used it */
|
|
if ( isset( $uses[ $customerIdentifier ] ) )
|
|
{
|
|
$uses[ $customerIdentifier ]++;
|
|
}
|
|
else
|
|
{
|
|
$uses[ $customerIdentifier ] = 1;
|
|
}
|
|
$this->used_by = json_encode( $uses );
|
|
$this->save();
|
|
|
|
/* Generate item */
|
|
$item = new \IPS\nexus\extensions\nexus\Item\CouponDiscount( $this->code, $discount );
|
|
$item->id = $this->id;
|
|
$item->extra['usedBy'] = $customer->member_id;
|
|
$item->extra['type'] = $this->unit;
|
|
$item->extra['value'] = $this->unit === 'v' ? $discount->amount : $this->discount;
|
|
$item->extra['items'] = $items;
|
|
return $item;
|
|
}
|
|
} |