Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add HasTypeIDWithAmount interface #180

Merged
merged 3 commits into from
Apr 3, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions src/Contracts/HasTypeIDWithAmount.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?php

/*
* This file is part of SeAT
*
* Copyright (C) 2015 to present Leon Jacobs
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

namespace Seat\Services\Contracts;

/**
* This interface is something between HasTypeID and IPriceable for things that have an amount and type but no price, like an asset list.
* The goal is to improve cross-plugin item handling compatibility.
*/
interface HasTypeIDWithAmount extends HasTypeID
{
/**
* @return int The amount of items
*/
public function getAmount(): int;
}
7 changes: 1 addition & 6 deletions src/Contracts/IPriceable.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,8 @@
* This interface is in the services package to encourage making classes that describe items compatible across both the
* seat core and plugin, even if they don't depend on recursivetree/seat-prices-core.
*/
interface IPriceable extends HasTypeID
interface IPriceable extends HasTypeID, HasTypeIDWithAmount
Crypta-Eve marked this conversation as resolved.
Show resolved Hide resolved
{
/**
* @return int The amount of items to be appraised by a price provider
*/
public function getAmount(): int;

/**
* Set the price of this object.
*
Expand Down
52 changes: 52 additions & 0 deletions src/Items/EveTypeWithAmount.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php

/*
* This file is part of SeAT
*
* Copyright (C) 2015 to present Leon Jacobs
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

namespace Seat\Services\Items;

use Seat\Services\Contracts\HasTypeID;
use Seat\Services\Contracts\HasTypeIDWithAmount;

/**
* A simple implementation on HasTypeIDWithAmount.
*/
class EveTypeWithAmount extends EveType implements HasTypeIDWithAmount
{
private int $amount;

/**
* @param int|HasTypeID $type_id
* @param int $amount
*/
public function __construct(int|HasTypeID $type_id, int $amount)
{
parent::__construct($type_id);
$this->amount = $amount;
}

/**
* @return int The amount of items
*/
public function getAmount(): int
{
return $this->amount;
}
}
18 changes: 4 additions & 14 deletions src/Items/PriceableEveType.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,28 +28,18 @@
/**
* A basic implementation od IPriceable.
*/
class PriceableEveType extends EveType implements IPriceable
class PriceableEveType extends EveTypeWithAmount implements IPriceable
{
protected float $price;
protected float $amount;

/**
* @param int|HasTypeID $type_id The eve type to be appraised
* @param float $amount The amount of this type to be appraised
* @param float|int $amount The amount of this type to be appraised
*/
public function __construct(int|HasTypeID $type_id, float $amount)
public function __construct(int|HasTypeID $type_id, float|int $amount)
{
parent::__construct($type_id);
parent::__construct($type_id, (int) $amount);
$this->price = 0;
$this->amount = $amount;
}

/**
* @return int The amount of this item to be appraised
*/
public function getAmount(): int
{
return $this->amount;
}

/**
Expand Down
Loading