Merge pull request #51 from enupal/develop

Develop
enupal · May 21, 2022 · a9fb13b · a9fb13b
2 parents fd32f19 + dc78fed
commit a9fb13b
Show file tree

Hide file tree

Showing 9 changed files with 33 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Enupal Snapshot Changelog
 
+## 2.0.0 - 2022.05.21
+
+### Added
+- Added Craft CMS 4 support
+
 ## 1.2.8 - 2020.07.02
 ### Added
 - Added `autosuggestField` to the Stripe Payments Order PDF Template setting

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 	<img width="212" height="212" src="https://enupal.com/assets/docs/snapshot-icon.svg" alt="Enupal Snapshot"></a>
 </p>
 
-# Enupal Snapshot Plugin for Craft CMS 3.x
+# Enupal Snapshot Plugin for Craft CMS
 
 PDF or Image generation from a URL or HTML page easily. It uses the excellent webkit-based wkhtmltopdf and wkhtmltoimage available on OSX, Linux & windows.
 ## Features

diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
   "name": "enupal/snapshot",
   "description": "PDF or Image generation from a Url or HTML page",
   "type": "craft-plugin",
-  "version": "1.2.8",
+  "version": "2.0.0",
   "keywords": [
     "craft",
     "cms",
@@ -24,7 +24,7 @@
     }
   ],
   "require": {
-    "craftcms/cms": "^3.1.0",
+    "craftcms/cms": "^4.0.0",
     "knplabs/knp-snappy": "^1.0"
   },
   "autoload": {

diff --git a/src/Snapshot.php b/src/Snapshot.php
@@ -47,17 +47,17 @@ class Snapshot extends Plugin
     /**
      * @inheritdoc
      */
-    public $schemaVersion = '1.2.0';
+    public string $schemaVersion = '2.0.0';
 
     /**
      * @inheritdoc
      */
-    public $hasCpSection = false;
+    public bool $hasCpSection = false;
 
     /**
      * @inheritdoc
      */
-    public $hasCpSettings = true;
+    public bool $hasCpSettings = true;
 
     /**
      * @inheritdoc
@@ -133,15 +133,15 @@ function(Event $event) {
     /**
      * @inheritdoc
      */
-    protected function createSettingsModel()
+    protected function createSettingsModel(): ?\craft\base\Model
     {
         return new Settings();
     }
 
     /**
      * @inheritdoc
      */
-    protected function settingsHtml(): string
+    protected function settingsHtml(): ?string
     {
         return Craft::$app->view->renderTemplate(
             'enupal-snapshot/settings',
@@ -191,7 +191,7 @@ private function isStripePaymentsInstalled()
     {
         $stripePluginHandle = 'enupal-stripe';
         $projectConfig = Craft::$app->getProjectConfig();
-        $stripePaymentsSettings = $projectConfig->get(Plugins::CONFIG_PLUGINS_KEY.'.'.$stripePluginHandle);
+        $stripePaymentsSettings = $projectConfig->get(\craft\services\ProjectConfig::PATH_PLUGINS.'.'.$stripePluginHandle);
         $isInstalled = $stripePaymentsSettings['enabled'] ?? false;
 
         return $isInstalled;

diff --git a/src/contracts/BaseSnappy.php b/src/contracts/BaseSnappy.php
@@ -12,8 +12,8 @@
 
 use Craft;
 use craft\elements\Asset;
+use craft\errors\AssetException;
 use craft\errors\InvalidSubpathException;
-use craft\errors\InvalidVolumeException;
 use craft\helpers\UrlHelper;
 use enupal\snapshot\models\Settings;
 use enupal\snapshot\Snapshot;
@@ -174,9 +174,9 @@ public function getSettings(SnappySettings $settings, $isPdf = true): SnappySett
         }
 
         if (!$isValidFileName) {
-            $info = Craft::$app->getInfo();
+            $primarySite = Craft::$app->getSites()->getPrimarySite();
             $systemName = FileHelper::sanitizeFilename(
-                $info->name,
+                $primarySite->getName(),
                 [
                     'asciiOnly' => true,
                     'separator' => '_'
@@ -202,7 +202,7 @@ public function getSettings(SnappySettings $settings, $isPdf = true): SnappySett
      * @param SnappySettings $settingsModel
      * @return Asset
      * @throws InvalidSubpathException
-     * @throws InvalidVolumeException
+     * @throws AssetException
      * @throws \Throwable
      * @throws \craft\errors\ElementNotFoundException
      * @throws \craft\errors\VolumeException
@@ -311,7 +311,7 @@ public function getStripePaymentsFilename($settings, $isPdf = true)
      * @param SnappySettings $settingsModel
      * @return array|\craft\base\ElementInterface|Asset|null
      * @throws InvalidSubpathException
-     * @throws InvalidVolumeException
+     * @throws AssetException
      * @throws \craft\errors\VolumeException
      */
     public function getAssetIfFileExists($settingsModel)
@@ -333,7 +333,7 @@ public function getAssetIfFileExists($settingsModel)
      * @param SnappySettings $settingsModel
      * @return int
      * @throws InvalidSubpathException if the folder subpath is not valid
-     * @throws InvalidVolumeException if there's a problem with the field's volume configuration
+     * @throws AssetException if there's a problem with the field's volume configuration
      * @throws \craft\errors\VolumeException
      */
     private function determineUploadFolderId($settingsModel): int
@@ -354,11 +354,11 @@ private function determineUploadFolderId($settingsModel): int
 
         try {
             if (!$uploadVolume) {
-                throw new InvalidVolumeException();
+                throw new AssetException();
             }
             $folderId = $this->resolveVolumePathToFolderId($uploadVolume, $subpath);
-        } catch (InvalidVolumeException $e) {
-            throw new InvalidVolumeException(Craft::t('app', '{setting} setting is set to an invalid volume.', [
+        } catch (AssetException $e) {
+            throw new AssetException(Craft::t('app', '{setting} setting is set to an invalid volume.', [
                 'setting' => $settingName,
             ]), 0, $e);
         } catch (InvalidSubpathException $e) {
@@ -379,7 +379,7 @@ private function determineUploadFolderId($settingsModel): int
      * @param string $subpath
      * @return int
      * @throws InvalidSubpathException
-     * @throws InvalidVolumeException if the volume root folder doesn’t exist
+     * @throws AssetException if the volume root folder doesn’t exist
      * @throws \craft\errors\VolumeException
      */
     private function resolveVolumePathToFolderId(string $uploadSource, string $subpath): int
@@ -390,7 +390,7 @@ private function resolveVolumePathToFolderId(string $uploadSource, string $subpa
 
         // Make sure the volume and root folder actually exists
         if ($volumeId === null || ($rootFolder = $assetsService->getRootFolderByVolumeId($volumeId)) === null) {
-            throw new InvalidVolumeException();
+            throw new AssetException();
         }
 
         // Are we looking for a subfolder?
@@ -430,7 +430,8 @@ private function resolveVolumePathToFolderId(string $uploadSource, string $subpa
 
             if (!$folder) {
                 $volume = Craft::$app->getVolumes()->getVolumeById($volumeId);
-                $folderId = $assetsService->ensureFolderByFullPathAndVolume($subpath, $volume);
+                $folder = $assetsService->ensureFolderByFullPathAndVolume($subpath, $volume);
+                $folderId = $folder->id;
             } else {
                 $folderId = $folder->id;
             }
@@ -453,9 +454,9 @@ public function volumeIdBySourceKey(string $sourceKey)
             return null;
         }
 
-        $folder = Craft::$app->getAssets()->getFolderByUid($parts[1]);
+        $volume = Craft::$app->getVolumes()->getVolumeByUid($parts[1]);
 
-        return $folder->volumeId ?? null;
+        return $volume->id ?? null;
     }
 
     /**

diff --git a/src/contracts/SnappyPdf.php b/src/contracts/SnappyPdf.php
@@ -138,7 +138,7 @@ public function displayUrl($url, $settings = null)
      * @param array $options
      *
      * @return array
-     * @throws \Twig_Error_Loader
+     * @throws \Twig\Error\LoaderError
      * @throws \yii\base\Exception
      */
     public function getDefaultOptions($options = [])

diff --git a/src/migrations/m190123_000000_asset_setting_change.php b/src/migrations/m190123_000000_asset_setting_change.php
@@ -39,7 +39,7 @@ public function safeUp()
         }
 
         $projectConfig = Craft::$app->getProjectConfig();
-        $projectConfig->set(Plugins::CONFIG_PLUGINS_KEY . '.' . $plugin->handle . '.settings', $settings->toArray());
+        $projectConfig->set(\craft\services\ProjectConfig::PATH_PLUGINS . '.' . $plugin->handle . '.settings', $settings->toArray());
 
         return true;
     }

diff --git a/src/models/Settings.php b/src/models/Settings.php
@@ -77,7 +77,7 @@ class Settings extends Model
     /**
      * @inheritdoc
      */
-    public function rules()
+    public function rules(): array
     {
         return [
             [['pdfBinPath', 'imageBinPath'], 'required'],

diff --git a/src/services/App.php b/src/services/App.php
@@ -34,7 +34,7 @@ class App extends Component
      */
     public $settings;
 
-    public function init()
+    public function init(): void
     {
         $this->pdf = new Pdf();
         $this->image = new Image();