Various updates for new admin and site packages, and some phpstan fixes

silverorange · Oct 30, 2024 · 185aa78 · 185aa78
1 parent 5529589
commit 185aa78
Show file tree

Hide file tree

Showing 115 changed files with 244 additions and 286 deletions.
diff --git a/Store/Store.php b/Store/Store.php
@@ -162,13 +162,6 @@ public static function init()
 
 		SiteViewFactory::addPath('Store/views');
 
-		if (class_exists('Blorg')) {
-			SiteViewFactory::registerView(
-				'post-search',
-				'StoreBlorgPostSearchView'
-			);
-		}
-
 		self::$is_initialized = true;
 	}
 

diff --git a/Store/StoreArticlePageFactory.php b/Store/StoreArticlePageFactory.php
@@ -25,7 +25,7 @@ public function __construct(SiteApplication $app)
 	// }}}
 	// {{{ protected function isVisible()
 
-	protected function isVisible(SiteArticle $article, $source)
+	protected function isVisible(SiteArticle $article, $source): bool
 	{
 		$region = $this->app->getRegion();
 		$sql = sprintf('select count(id) from EnabledArticleView
@@ -51,7 +51,8 @@ protected function isVisible(SiteArticle $article, $source)
 	protected function getNotVisiblePage(
 		SiteArticle $article,
 		SiteLayout $layout
-	) {
+	): SitePage
+	{
 		$page = new SitePage($this->app, $layout);
 		$page = $this->decorate($page, 'StoreArticleNotVisiblePage');
 		$page->setArticle($article);
@@ -69,7 +70,7 @@ protected function getNotVisiblePage(
 	 * @return SiteArticle the specified article or null if no such article
 	 *                       exists.
 	 */
-	protected function getArticle($path)
+	protected function getArticle($path): SiteArticle
 	{
 		$article = parent::getArticle($path);
 		$article->setRegion($this->app->getRegion());

diff --git a/Store/StoreCartLightbox.php b/Store/StoreCartLightbox.php
@@ -48,6 +48,8 @@ class StoreCartLightbox extends SwatControl
 	 */
 	protected $app;
 
+	private ?StoreCartProcessor $processor = null;
+
 	/**
 	 * @var SwatUI
 	 */

diff --git a/Store/StoreItemsView.php b/Store/StoreItemsView.php
@@ -28,6 +28,8 @@ class StoreItemsView extends SwatControl
 
 	protected $has_description = false;
 
+	protected string $source;
+
 	/**
 	 * @var boolean
 	 */

diff --git a/Store/StorePageFactory.php b/Store/StorePageFactory.php
@@ -24,7 +24,7 @@ public function __construct(SiteApplication $app)
 	// }}}
 	// {{{ public function resolvePage()
 
-	public function resolvePage($source, SiteLayout $layout = null)
+	public function resolvePage($source, SiteLayout $layout = null): SiteAbstractPage
 	{
 		$layout = ($layout === null) ? $this->resolveLayout($source) : $layout;
 

diff --git a/Store/StorePayPalPaymentProvider.php b/Store/StorePayPalPaymentProvider.php
@@ -117,7 +117,7 @@ public function __construct(array $parameters = array())
 
 		$valid_modes = array('live', 'sandbox');
 		if (!in_array($parameters['mode'], $valid_modes)) {
-			throw new StoreException('Mode "'.$mode.'" is not valid for '.
+			throw new StoreException('Mode "'.$parameters['mode'].'" is not valid for '.
 				'the PayPal payment provider.');
 		}
 
@@ -830,7 +830,7 @@ public function formatString($string, $max_length = 0)
 
 		// truncate to max_length
 		if ($max_length > 0) {
-			$string = mb_mb_substr($string, 0, $max_length);
+			$string = mb_substr($string, 0, $max_length);
 		}
 
 		return $string;
@@ -1475,7 +1475,7 @@ protected function getCreditCardType(StoreOrderPaymentMethod $payment_method)
 			break;
 
 		default:
-			throw new StorePaymentException('Unsupported card type in order.');
+			throw new StorePaymentCardTypeException('Unsupported card type in order.');
 		}
 
 		return $type;

diff --git a/Store/StoreShipmentMethod.php b/Store/StoreShipmentMethod.php
@@ -14,11 +14,12 @@ class StoreShipmentMethod
 	/**
 	 * An approximation of how long it takes to ship items with this method.
 	 *
-	 * @return DateInterval the approximate time it will take to deliver a
-	 *                      shipment using this method.
+	 * @return ?DateInterval the approximate time it will take to deliver a
+	 *                       shipment using this method, or null.
 	 */
-	public function getTimeToDeliver($address)
+	public function getTimeToDeliver($address): ?DateInterval
 	{
+		return null;
 	}
 
 	// }}}

diff --git a/Store/StoreStatusList.php b/Store/StoreStatusList.php
@@ -17,10 +17,8 @@ abstract class StoreStatusList extends SwatObject implements Iterator, Countable
 
 	/**
 	 * Index value used to implement the iterator interface for this list
-	 *
-	 * @var integer
 	 */
-	private $current_index = 0;
+	private int $current_index = 0;
 
 	// }}}
 	// {{{ protected properties
@@ -97,7 +95,7 @@ public function getByShortname($shortname)
 	 *
 	 * @return mixed the current status.
 	 */
-	public function current()
+	public function current(): mixed
 	{
 		return $this->statuses[$this->current_index];
 	}
@@ -108,9 +106,9 @@ public function current()
 	/**
 	 * Returns the key of the current status
 	 *
-	 * @return integer the key of the current status
+	 * @return int the key of the current status
 	 */
-	public function key()
+	public function key(): int
 	{
 		return $this->current_index;
 	}
@@ -121,7 +119,7 @@ public function key()
 	/**
 	 * Moves forward to the next status
 	 */
-	public function next()
+	public function next(): void
 	{
 		$this->current_index++;
 	}
@@ -143,7 +141,7 @@ public function prev()
 	/**
 	 * Rewinds this iterator to the first status
 	 */
-	public function rewind()
+	public function rewind(): void
 	{
 		$this->current_index = 0;
 	}
@@ -154,10 +152,10 @@ public function rewind()
 	/**
 	 * Checks is there is a current status after calls to rewind() and next()
 	 *
-	 * @return boolean true if there is a current status and false if there
-	 *                  is not.
+	 * @return bool true if there is a current status and false if there
+	 *              is not.
 	 */
-	public function valid()
+	public function valid(): bool
 	{
 		return isset($this->statuses[$this->current_index]);
 	}
@@ -170,9 +168,9 @@ public function valid()
 	 *
 	 * This satisfies the Countable interface.
 	 *
-	 * @return integer the number of statuses in this list.
+	 * @return int the number of statuses in this list.
 	 */
-	public function count()
+	public function count(): int
 	{
 		return count($this->statuses);
 	}

diff --git a/Store/StoreVoucherRow.php b/Store/StoreVoucherRow.php
@@ -10,6 +10,8 @@ class StoreVoucherRow extends StoreTotalRow
 {
 	// {{{ public function __construct()
 
+	protected SwatButton $remove_button;
+
 	public function __construct()
 	{
 		parent::__construct();

diff --git a/Store/StoreXMLRPCServerFactory.php b/Store/StoreXMLRPCServerFactory.php
@@ -19,7 +19,7 @@ public function __construct(SiteApplication $app)
 	// }}}
 	// {{{ protected function getPageMap()
 
-	protected function getPageMap()
+	protected function getPageMap(): array
 	{
 		return array(
 			'search-panel' => 'StoreSearchPanelServer',

diff --git a/Store/admin/components/Account/AddressDelete.php b/Store/admin/components/Account/AddressDelete.php
@@ -19,7 +19,7 @@ class StoreAccountAddressDelete extends AdminDBDelete
 	// process phase
 	// {{{ protected function processDBData()
 
-	protected function processDBData()
+	protected function processDBData(): void
 	{
 		parent::processDBData();
 

diff --git a/Store/admin/components/Account/AddressEdit.php b/Store/admin/components/Account/AddressEdit.php
@@ -189,7 +189,7 @@ protected function getCountry()
 	// }}}
 	// {{{ protected function saveDBData()
 
-	protected function saveDBData()
+	protected function saveDBData(): void
 	{
 		$values = $this->getUIValues();
 
@@ -263,7 +263,7 @@ protected function getUIValues()
 	// }}}
 	// {{{ protected function validate()
 
-	protected function validate()
+	protected function validate(): void
 	{
 		$provstate = $this->ui->getWidget('provstate');
 		$country = $this->ui->getWidget('country');

diff --git a/Store/admin/components/Account/Details.php b/Store/admin/components/Account/Details.php
@@ -105,7 +105,7 @@ protected function setTimeZone()
 	// }}}
 	// {{{ protected function getTableModel()
 
-	protected function getTableModel(SwatView $view)
+	protected function getTableModel(SwatView $view): ?SwatTableModel
 	{
 		switch ($view->id) {
 		case 'orders_view':
@@ -115,12 +115,13 @@ protected function getTableModel(SwatView $view)
 		case 'payment_methods_view':
 			return $this->getPaymentMethodsTableModel($view);
 		}
+		return null;
 	}
 
 	// }}}
 	// {{{ protected function getOrdersTableModel()
 
-	protected function getOrdersTableModel(SwatTableView $view)
+	protected function getOrdersTableModel(SwatTableView $view): SwatDBDefaultRecordsetWrapper
 	{
 		$sql = 'select Orders.id,
 					Orders.account as account_id,
@@ -143,7 +144,7 @@ protected function getOrdersTableModel(SwatTableView $view)
 	// }}}
 	// {{{ protected function getAddressesTableModel()
 
-	protected function getAddressesTableModel(SwatTableView $view)
+	protected function getAddressesTableModel(SwatTableView $view): SwatTableStore
 	{
 		$account = $this->getAccount();
 		$billing_id = $account->getInternalValue('default_billing_address');
@@ -167,7 +168,7 @@ protected function getAddressesTableModel(SwatTableView $view)
 	// }}}
 	// {{{ protected function getPaymentMethodsTableModel()
 
-	protected function getPaymentMethodsTableModel(SwatTableView $view)
+	protected function getPaymentMethodsTableModel(SwatTableView $view): SwatTableStore
 	{
 		$wrapper = SwatDBClassMap::get('StoreAccountPaymentMethodWrapper');
 

diff --git a/Store/admin/components/Account/PaymentMethodDelete.php b/Store/admin/components/Account/PaymentMethodDelete.php
@@ -19,7 +19,7 @@ class StoreAccountPaymentMethodDelete extends AdminDBDelete
 	// process phase
 	// {{{ protected function processDBData()
 
-	protected function processDBData()
+	protected function processDBData(): void
 	{
 		parent::processDBData();
 

diff --git a/Store/admin/components/Account/PaymentMethodEdit.php b/Store/admin/components/Account/PaymentMethodEdit.php
@@ -81,7 +81,7 @@ protected function getPaymentMethod()
 	// process phase
 	// {{{ protected function saveDBData()
 
-	protected function saveDBData()
+	protected function saveDBData(): void
 	{
 		$payment_method = $this->getPaymentMethod();
 		$payment_method->payment_type =

diff --git a/Store/admin/components/Ad/Details.php b/Store/admin/components/Ad/Details.php
@@ -35,7 +35,7 @@ protected function getUiXml()
 	// build phase
 	// {{{ protected function getTableModel()
 
-	protected function getTableModel(SwatView $view)
+	protected function getTableModel(SwatView $view): ?SwatTableModel
 	{
 		switch ($view->id) {
 		case 'orders_view':
@@ -48,7 +48,7 @@ protected function getTableModel(SwatView $view)
 	// }}}
 	// {{{ protected function getOrdersTableModel()
 
-	protected function getOrdersTableModel()
+	protected function getOrdersTableModel(): SwatTableStore
 	{
 		$regions = $this->queryRegions();
 		$this->appendRegionColumns($regions);

diff --git a/Store/admin/components/Ad/Index.php b/Store/admin/components/Ad/Index.php
@@ -24,7 +24,7 @@ protected function getUiXml()
 	// build phase
 	// {{{ protected function getTableModel()
 
-	protected function getTableModel(SwatView $view)
+	protected function getTableModel(SwatView $view): SwatDBDefaultRecordsetWrapper
 	{
 		$sql = sprintf('select Ad.*,
 				coalesce(OrderCountByAdView.order_count, 0) as order_count,

diff --git a/Store/admin/components/Article/Edit.php b/Store/admin/components/Article/Edit.php
@@ -32,7 +32,7 @@ protected function getUiXml()
 	// process phase
 	// {{{ protected function saveDBData()
 
-	protected function saveDBData()
+	protected function saveDBData(): void
 	{
 		parent::saveDBData();
 

diff --git a/Store/admin/components/Attribute/Delete.php b/Store/admin/components/Attribute/Delete.php
@@ -12,7 +12,7 @@ class StoreAttributeDelete extends AdminDBDelete
 	// process phase
 	// {{{ protected function processDBData()
 
-	protected function processDBData()
+	protected function processDBData(): void
 	{
 		parent::processDBData();
 

diff --git a/Store/admin/components/Attribute/Edit.php b/Store/admin/components/Attribute/Edit.php
@@ -75,7 +75,7 @@ protected function getUiXml()
 	// process phase
 	// {{{ protected function validate()
 
-	protected function validate()
+	protected function validate(): void
 	{
 		$shortname = $this->ui->getWidget('shortname');
 
@@ -97,7 +97,7 @@ protected function validate()
 
 	// {{{ protected function saveDBData()
 
-	protected function saveDBData()
+	protected function saveDBData(): void
 	{
 		$this->updateAttribute();
 		$this->attribute->save();

diff --git a/Store/admin/components/Attribute/Index.php b/Store/admin/components/Attribute/Index.php
@@ -43,7 +43,7 @@ protected function processActions(SwatView $view, SwatActions $actions)
 	// build phase
 	// {{{ protected function getTableModel()
 
-	protected function getTableModel(SwatView $view)
+	protected function getTableModel(SwatView $view): SwatTableStore
 	{
 		$sql = sprintf('select Attribute.*
 			from Attribute

diff --git a/Store/admin/components/AttributeType/Delete.php b/Store/admin/components/AttributeType/Delete.php
@@ -12,7 +12,7 @@ class StoreAttributeTypeDelete extends AdminDBDelete
 	// process phase
 	// {{{ protected function processDBData()
 
-	protected function processDBData()
+	protected function processDBData(): void
 	{
 		parent::processDBData();
 

diff --git a/Store/admin/components/AttributeType/Edit.php b/Store/admin/components/AttributeType/Edit.php
@@ -53,7 +53,7 @@ protected function initAttributeType()
 	// process phase
 	// {{{ protected function validate()
 
-	protected function validate()
+	protected function validate(): void
 	{
 		$shortname = $this->ui->getWidget('shortname');
 
@@ -74,7 +74,7 @@ protected function validate()
 	// }}}
 	// {{{ protected function saveDBData()
 
-	protected function saveDBData()
+	protected function saveDBData(): void
 	{
 		$this->updateAttributeType();
 		$this->attribute_type->save();
-Original file line number
+Diff line change
@@ Expand Up / @@ -48,6 +48,8 @@ class StoreCartLightbox extends SwatControl @@
     	 */
     	protected $app;
+    	private ?StoreCartProcessor $processor = null;
     	/**
     	 * @var SwatUI
     	 */
@@ Expand Down @@