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.

Sign up for GitHub

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

Feature - Add beginning and ending dates to product label #56

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Feature - Add beginning and ending dates to product label #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 42 additions & 0 deletions Api/Data/ProductLabelInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,16 @@ interface ProductLabelInterface
*/
public const OPTION_ID = 'option_id';

/**
* Constant for field from_date
*/
const FROM_DATE = 'from_date';

/**
* Constant for field to_date
*/
const TO_DATE = 'to_date';

/**
* Constant for field image
*/
Expand Down Expand Up @@ -133,6 +143,20 @@ public function getAttributeId(): int;
*/
public function getOptionId(): int;

/**
* Get from date
*
* @return string
*/
public function getFromDate(): string;

/**
* Get to date
*
* @return string
*/
public function getToDate(): string;

/**
* Get image
*
Expand Down Expand Up @@ -208,6 +232,24 @@ public function setAttributeId(int $value): ProductLabelInterface;
*/
public function setOptionId(int $value): ProductLabelInterface;

/**
* Set from date
*
* @param string $value From Date
*
* @return ProductLabelInterface
*/
public function setFromDate(string $value);

/**
* Set to date
*
* @param string $value To Date
*
* @return ProductLabelInterface
*/
public function setToDate(string $value);

/**
* Set Image.
*
Expand Down
10 changes: 10 additions & 0 deletions Block/ProductLabel/ProductLabel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
use Magento\Framework\App\CacheInterface;
use Magento\Framework\DataObject\IdentityInterface;
use Magento\Framework\Registry;
use Magento\Framework\Stdlib\DateTime\TimezoneInterface;
use Magento\Framework\View\Element\Template;
use Magento\Store\Model\StoreManagerInterface;
use Smile\ProductLabel\Api\Data\ProductLabelInterface;
Expand Down Expand Up @@ -42,6 +43,7 @@ class ProductLabel extends Template implements IdentityInterface
* @param ProductLabelCollectionFactory $productLabelCollectionFactory Product Label Collection Factory
* @param CacheInterface $cache Cache Interface
* @param ?ProductInterface $product Product interface
* @param TimezoneInterface $timezoneInterface Timezone Interface
* @param array $data Block data
*/
public function __construct(
Expand All @@ -51,6 +53,7 @@ public function __construct(
ProductLabelCollectionFactory $productLabelCollectionFactory,
CacheInterface $cache,
?ProductInterface $product,
TimezoneInterface $timezoneInterface,
array $data = []
) {
$this->registry = $registry;
Expand All @@ -59,6 +62,7 @@ public function __construct(
$this->cache = $cache;
$this->storeManager = $context->getStoreManager();
$this->product = $product;
$this->timezoneInterface = $timezoneInterface;
parent::__construct($context, $data);
}

Expand Down Expand Up @@ -168,6 +172,12 @@ public function getProductLabels(): array
$attributesProduct = $this->getAttributesOfCurrentProduct();

foreach ($productLabelList as $productLabel) {
if (
$productLabel['from_date'] > $this->timezoneInterface->date()->format('Y-m-d') ||
$productLabel['to_date'] < $this->timezoneInterface->date()->format('Y-m-d')
) {
continue;
}
$attributeIdLabel = $productLabel['attribute_id'];
$optionIdLabel = $productLabel['option_id'];
foreach ($attributesProduct as $attribute) {
Expand Down
42 changes: 42 additions & 0 deletions Model/ProductLabel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use Magento\Framework\App\ObjectManager;
use Magento\Framework\Data\Collection\AbstractDb;
use Magento\Framework\DataObject\IdentityInterface;
use Magento\Framework\Stdlib\DateTime\TimezoneInterface;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Filesystem;
use Magento\Framework\Filesystem\Directory\WriteInterface;
Expand Down Expand Up @@ -58,13 +59,15 @@ class ProductLabel extends AbstractModel implements IdentityInterface, ProductLa
* @param AbstractResource|null $resource Resource
* @param AbstractDb|null $resourceCollection Resource Collection
* @param ImageUploader $imageUploader Image uploader
* @param TimezoneInterface $timezoneInterface Timezone Interface
* @param array $data Object Data
*/
public function __construct(
Context $context,
Registry $registry,
StoreManagerInterface $storeManager,
Filesystem $filesystem,
TimezoneInterface $timezoneInterface,
?AbstractResource $resource = null,
?AbstractDb $resourceCollection = null,
?ImageUploader $imageUploader = null,
Expand All @@ -73,6 +76,7 @@ public function __construct(
$this->storeManager = $storeManager;
$this->mediaDirectory = $filesystem->getDirectoryWrite(DirectoryList::MEDIA);
$this->imageUploader = $imageUploader;
$this->timezoneInterface = $timezoneInterface;
parent::__construct(
$context,
$registry,
Expand Down Expand Up @@ -148,6 +152,22 @@ public function getOptionId(): int
return (int) $this->getData(self::OPTION_ID);
}

/**
* Get field: from_date
*/
public function getFromDate(): string
{
return (string) $this->getData(self::FROM_DATE);
}

/**
* Get field: to_date
*/
public function getToDate(): string
{
return (string) $this->getData(self::TO_DATE);
}

/**
* Get field: image
*/
Expand Down Expand Up @@ -245,6 +265,26 @@ public function setOptionId(int $value): ProductLabelInterface
return $this->setData(self::OPTION_ID, $value);
}

/**
* Set field: from_date.
*
* @param string $value Field value
*/
public function setFromDate(string $value): ProductLabelInterface
{
return (string) $this->setData(self::FROM_DATE, $value);
}

/**
* Set field: to_date.
*
* @param string $value Field value
*/
public function setToDate(string $value): ProductLabelInterface
{
return (string) $this->setData(self::TO_DATE, $value);
}

/**
* Set Image.
*
Expand Down Expand Up @@ -307,6 +347,8 @@ public function populateFromArray(array $values): void
$this->setData(self::PRODUCTLABEL_NAME, (string) $values['name']);
$this->setData(self::ATTRIBUTE_ID, (int) $values['attribute_id']);
$this->setData(self::OPTION_ID, (int) $values['option_id']);
$this->setData(self::FROM_DATE, (string) $this->timezoneInterface->date($values['from_date'])->format('Y-m-d H:i:s'));
$this->setData(self::TO_DATE, (string) $this->timezoneInterface->date($values['to_date'])->format('Y-m-d H:i:s'));
$this->setData(self::PRODUCTLABEL_IMAGE, $values['image'][0]['name']);
$this->setData(self::PRODUCTLABEL_POSITION_CATEGORY_LIST, (string) $values['position_category_list']);
$this->setData(self::PRODUCTLABEL_POSITION_PRODUCT_VIEW, (string) $values['position_product_view']);
Expand Down
2 changes: 2 additions & 0 deletions etc/db_schema.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
<column xsi:type="smallint" name="attribute_id" padding="5" unsigned="true" nullable="false" identity="false" default="0"
comment="Attribute ID"/>
<column xsi:type="int" name="option_id" padding="10" unsigned="true" nullable="false" identity="false" default="0" comment="Option Id"/>
<column xsi:type="date" name="from_date" nullable="true" comment="From Date"/>
<column xsi:type="date" name="to_date" nullable="true" comment="To Date"/>
<column xsi:type="blob" name="image" nullable="true" comment="Image of Attribute or Option of Attribute"/>
<column xsi:type="varchar" name="position_category_list" nullable="true" comment="Position of Image on Category List"/>
<column xsi:type="varchar" name="position_product_view" nullable="true" comment="Position of Image on Product View"/>
Expand Down
4 changes: 3 additions & 1 deletion i18n/en_US.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,6 @@
"Something went wrong while saving the product label. ""%1""","Something went wrong while saving the product label. ""%1"""
"Alternative text for this label","Alternative text for this label"
"All Store Views","All Store Views"
"Store View","Store View"
"Store View","Store View"
"From Date","From Date"
"To Date","To Date"
4 changes: 3 additions & 1 deletion i18n/fr_FR.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,6 @@
"A total of %1 product label(s) have been deleted.","Suppression de %1 étiquette(s) produit avec succès."
"Alternative text for this label","Texte alternatif du label"
"All Store Views","Toutes les vues magasin"
"Store View","Vue magasin"
"Store View","Vue magasin"
"From Date","De la date"
"To Date","À la date"
47 changes: 42 additions & 5 deletions view/adminhtml/ui_component/smile_productlabel_productlabel_form.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,43 @@
</formElements>
</field>

<field name="image" formElement="imageUploader" sortOrder="50">
<field name="from_date" formElement="date" sortOrder="50">
<argument name="data" xsi:type="array">
<item name="config" xsi:type="array">
<item name="source" xsi:type="string">from_date</item>
</item>
</argument>
<settings>
<validation>
<rule name="validate-date" xsi:type="boolean">true</rule>
<rule name="required-entry" xsi:type="boolean">true</rule>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why make these fields required ?

</validation>
<dataType>text</dataType>
<label translate="true">Form Date</label>
<visible>true</visible>
<dataScope>from_date</dataScope>
</settings>
</field>

<field name="to_date" formElement="date" sortOrder="55">
<argument name="data" xsi:type="array">
<item name="config" xsi:type="array">
<item name="source" xsi:type="string">to_date</item>
</item>
</argument>
<settings>
<validation>
<rule name="validate-date" xsi:type="boolean">true</rule>
<rule name="required-entry" xsi:type="boolean">true</rule>
</validation>
<dataType>text</dataType>
<label translate="true">To Date</label>
<visible>true</visible>
<dataScope>to_date</dataScope>
</settings>
</field>

<field name="image" formElement="imageUploader" sortOrder="60">
<argument name="data" xsi:type="array">
<item name="config" xsi:type="array">
<item name="source" xsi:type="string">productlabel</item>
Expand All @@ -232,6 +268,7 @@
<settings>
<validation>
<rule name="required-entry" xsi:type="boolean">true</rule>
<rule name="required-entry" xsi:type="boolean">true</rule>
</validation>
<elementTmpl>ui/form/element/uploader/image</elementTmpl>
<dataType>string</dataType>
Expand All @@ -256,7 +293,7 @@
</formElements>
</field>

<field name="position_category_list" formElement="select" sortOrder="60">
<field name="position_category_list" formElement="select" sortOrder="70">
<argument name="data" xsi:type="array">
<item name="options" xsi:type="object">Smile\ProductLabel\Ui\Component\Source\Location\Options</item>
<item name="config" xsi:type="array">
Expand All @@ -276,7 +313,7 @@
</settings>
</field>

<field name="position_product_view" formElement="select" sortOrder="70">
<field name="position_product_view" formElement="select" sortOrder="80">
<argument name="data" xsi:type="array">
<item name="options" xsi:type="object">Smile\ProductLabel\Ui\Component\Source\Location\Options</item>
<item name="config" xsi:type="array">
Expand All @@ -296,7 +333,7 @@
</settings>
</field>

<field name="display_on" formElement="multiselect" sortOrder="80">
<field name="display_on" formElement="multiselect" sortOrder="90">
<argument name="data" xsi:type="array">
<item name="config" xsi:type="array">
<item name="source" xsi:type="string">productlabel</item>
Expand All @@ -320,7 +357,7 @@
</formElements>
</field>

<field name="alt" formElement="input" sortOrder="90">
<field name="alt" formElement="input" sortOrder="100">
<argument name="data" xsi:type="array">
<item name="config" xsi:type="array">
<item name="source" xsi:type="string">alt</item>
Expand Down
26 changes: 23 additions & 3 deletions view/adminhtml/ui_component/smile_productlabel_productlabel_listing.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,27 @@
</settings>
</column>

<column name="is_active" sortOrder="60" component="Magento_Ui/js/grid/columns/select">
<column name="from_date" sortOrder="60" class="Magento\Ui\Component\Listing\Columns\Date"
component="Magento_Ui/js/grid/columns/date">
<settings>
<filter>dateRange</filter>
<dataType>date</dataType>
<dataType>date</dataType>
<label translate="true">From Date</label>
</settings>
</column>

<column name="to_date" sortOrder="65" class="Magento\Ui\Component\Listing\Columns\Date"
component="Magento_Ui/js/grid/columns/date">
<settings>
<filter>dateRange</filter>
<dataType>date</dataType>
<dataType>date</dataType>
<label translate="true">To Date</label>
</settings>
</column>

<column name="is_active" sortOrder="70" component="Magento_Ui/js/grid/columns/select">
<settings>
<options>
<option name="active" xsi:type="array">
Expand All @@ -198,15 +218,15 @@
</settings>
</column>

<column name="store_id" class="Magento\Store\Ui\Component\Listing\Column\Store" sortOrder="65">
<column name="store_id" class="Magento\Store\Ui\Component\Listing\Column\Store" sortOrder="80">
<settings>
<label translate="true">Store View</label>
<bodyTmpl>ui/grid/cells/html</bodyTmpl>
<sortable>false</sortable>
</settings>
</column>

<actionsColumn sortOrder="70" name="actions" class="Smile\ProductLabel\Ui\Component\Listing\Column\AttributeActions">
<actionsColumn sortOrder="90" name="actions" class="Smile\ProductLabel\Ui\Component\Listing\Column\AttributeActions">
<settings>
<indexField>product_label_id</indexField>
</settings>
Expand Down