Source of file SoldArticlesParameter.php
Size: 10,671 Bytes - Last Modified: 2015-04-17T00:11:29+02:00
/www-data/git/ricardo/src/Diglin/Ricardo/Managers/SellerAccount/Parameter/SoldArticlesParameter.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525 | <?php /** * Diglin GmbH - Switzerland * * This file is part of a Diglin GmbH module. * * This Diglin GmbH module is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License version 3 as * published by the Free Software Foundation. * * This script 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. * * @author Sylvain Rayé <support at diglin.com> * @category Diglin * @package Diglin_Ricardo * @copyright Copyright (c) 2011-2015 Diglin (http://www.diglin.com) * @license http://opensource.org/licenses/gpl-3.0 GNU General Public License, version 3 (GPLv3) */ namespace Diglin\Ricardo\Managers\SellerAccount\Parameter; use Diglin\Ricardo\Enums\Article\ArticlesTypes; use Diglin\Ricardo\Enums\Customer\SoldArticlesSortBy; use Diglin\Ricardo\Enums\Customer\PaidStatusFilter; use Diglin\Ricardo\Enums\Customer\ShippedStatusFilter; use \Diglin\Ricardo\Managers\ParameterAbstract; /** * Class SoldArticlesParameter * * Required properties must be sent to ricardo API but can be null * * @package Diglin\Ricardo\Managers\SellerAccount\Parameter */ class SoldArticlesParameter extends ParameterAbstract { /** * Required * * @var string */ protected $_articleTitleFilter = null; /** * Required * * @var int */ protected $_articleTypeFilter = ArticlesTypes::ALL; /** * Required * * @var string */ protected $_internalReferenceFilter = null; /** * Required * * @var string */ protected $_lastnameFilter = null; /** * Required * * @var string */ protected $_nicknameFilter = null; /** * Required * * @var bool */ protected $_isCompletedTransaction = false; /** * Optional * * @var array */ protected $_articleIdsFilter = null; /** * Optional * * @var bool */ protected $_ascendingSort = false; /** * Optional * * @var int */ protected $_pageNumber; /** * Optional * * @var int */ protected $_pageSize; /** * Optional * * @var int */ protected $_sortBy = SoldArticlesSortBy::SORTBYENDDATE; /** * Optional * * @var bool */ protected $_isArchived; /** * Optional * * @var string */ protected $_maximumEndDate; /** * Optional * * @var string */ protected $_minimumEndDate; /** * Optional * * @var int */ protected $_paidStatusFilter = PaidStatusFilter::ANY; /** * Optional * * @var int */ protected $_shippedStatusFilter = ShippedStatusFilter::ANY; /** * @var array */ protected $_excludedTransactionIdsFilter = array(); /** * @var array */ protected $_transactionIdsFilter = array(); /** * @var array */ protected $_requiredProperties = array( 'articleTitleFilter', 'articleTypeFilter', 'internalReferenceFilter', 'lastnameFilter', 'nicknameFilter', 'isCompletedTransaction', ); protected $_optionalProperties = array( 'articleIdsFilter', 'ascendingSort', 'pageNumber', 'pageSize', 'sortBy', 'isArchived', 'maximumEndDate', 'minimumEndDate', 'paidStatusFilter', 'shippedStatusFilter', 'excludedTransactionIdsFilter', 'transactionIdsFilter' ); /** * @param array $articleIdsFilter * @return $this */ public function setArticleIdsFilter($articleIdsFilter) { $this->_articleIdsFilter = (array) $articleIdsFilter; return $this; } /** * @return array */ public function getArticleIdsFilter() { return $this->_articleIdsFilter; } /** * @param mixed $articleTitleFilter * @return $this */ public function setArticleTitleFilter($articleTitleFilter) { $this->_articleTitleFilter = $articleTitleFilter; return $this; } /** * @return mixed */ public function getArticleTitleFilter() { return $this->_articleTitleFilter; } /** * @param int $articleTypeFilter * @return $this */ public function setArticleTypeFilter($articleTypeFilter) { $this->_articleTypeFilter = $articleTypeFilter; return $this; } /** * @return int */ public function getArticleTypeFilter() { $types = new ArticlesTypes(); if (!in_array($this->_articleTypeFilter, $types->getValues())) { $this->_articleTypeFilter = ArticlesTypes::ALL; } return $this->_articleTypeFilter; } /** * @param boolean $ascendingSort * @return $this */ public function setAscendingSort($ascendingSort) { $this->_ascendingSort = (bool) $ascendingSort; return $this; } /** * @return boolean */ public function getAscendingSort() { return (bool) $this->_ascendingSort; } /** * @param mixed $internalReferenceFilter * @return $this */ public function setInternalReferenceFilter($internalReferenceFilter) { $this->_internalReferenceFilter = $internalReferenceFilter; return $this; } /** * @return mixed */ public function getInternalReferenceFilter() { return $this->_internalReferenceFilter; } /** * @param mixed $lastnameFilter * @return $this */ public function setLastnameFilter($lastnameFilter) { $this->_lastnameFilter = $lastnameFilter; return $this; } /** * @return mixed */ public function getLastnameFilter() { return $this->_lastnameFilter; } /** * @param mixed $nicknameFilter * @return $this */ public function setNicknameFilter($nicknameFilter) { $this->_nicknameFilter = $nicknameFilter; return $this; } /** * @return mixed */ public function getNicknameFilter() { return $this->_nicknameFilter; } /** * @param null $pageNumber * @return $this */ public function setPageNumber($pageNumber) { $this->_pageNumber = $pageNumber; return $this; } /** * @return null */ public function getPageNumber() { return $this->_pageNumber; } /** * @param null $pageSize * @return $this */ public function setPageSize($pageSize) { $this->_pageSize = (int) $pageSize; return $this; } /** * @return null */ public function getPageSize() { $this->_pageSize = (int) $this->_pageSize; if (empty($this->_pageSize)) { $this->_pageSize = null; } return $this->_pageSize; } /** * @param null $sortBy * @return $this */ public function setSortBy($sortBy) { $this->_sortBy = (int) $sortBy; return $this; } /** * @return null */ public function getSortBy() { $this->_sortBy = (int) $this->_sortBy; if (empty($this->_sortBy)) { $this->_sortBy = null; } return $this->_sortBy; } /** * @param boolean $isArchived * @return $this */ public function setIsArchived($isArchived) { $this->_isArchived = (bool) $isArchived; return $this; } /** * @return boolean */ public function getIsArchived() { return (bool) $this->_isArchived; } /** * @param boolean $isCompletedTransaction * @return $this */ public function setIsCompletedTransaction($isCompletedTransaction) { $this->_isCompletedTransaction = (bool) $isCompletedTransaction; return $this; } /** * @return boolean */ public function getIsCompletedTransaction() { return (bool) $this->_isCompletedTransaction; } /** * @param mixed $maximumEndDate * @return $this */ public function setMaximumEndDate($maximumEndDate) { $this->_maximumEndDate = $maximumEndDate; return $this; } /** * @return mixed */ public function getMaximumEndDate() { return $this->_maximumEndDate; } /** * @param mixed $minimumEndDate * @return $this */ public function setMinimumEndDate($minimumEndDate) { $this->_minimumEndDate = $minimumEndDate; return $this; } /** * @return mixed */ public function getMinimumEndDate() { return $this->_minimumEndDate; } /** * @param int $paidStatusFilter * @return $this */ public function setPaidStatusFilter($paidStatusFilter) { $this->_paidStatusFilter = (int) $paidStatusFilter; return $this; } /** * @return int */ public function getPaidStatusFilter() { return (int) $this->_paidStatusFilter; } /** * @param int $shippedStatusFilter * @return $this */ public function setShippedStatusFilter($shippedStatusFilter) { $this->_shippedStatusFilter = (int) $shippedStatusFilter; return $this; } /** * @return int */ public function getShippedStatusFilter() { return (int) $this->_shippedStatusFilter; } /** * @return array */ public function getTransactionIdsFilter() { return $this->_transactionIdsFilter; } /** * @param array $transactionIdsFilter * @return $this */ public function setTransactionIdsFilter($transactionIdsFilter) { $this->_transactionIdsFilter = $transactionIdsFilter; return $this; } /** * @return array */ public function getExcludedTransactionIdsFilter() { return $this->_excludedTransactionIdsFilter; } /** * @param array $excludedTransactionIdsFilter * @return $this */ public function setExcludedTransactionIdsFilter($excludedTransactionIdsFilter) { $this->_excludedTransactionIdsFilter = $excludedTransactionIdsFilter; return $this; } } |