parasek/concretecms_utility

一些实用的、有观点的帮助工具,用于处理文件/图片,在生成图片/相册/滑块/文件列表等时。

4.0.1 2024-01-08 20:39 UTC

This package is auto-updated.

Last update: 2024-09-08 21:55:58 UTC


README

一些实用的、有观点的帮助工具,用于处理文件、图片、视频,在生成图片/相册/滑块/文件列表等时。

需要Concrete 9和PHP 8.1。

大多数方法将返回DTO对象或DTO对象的数组。您的编辑器应该帮助您进行自动完成。如果没有,请添加相应的代码

// Hints for services
/** @var \ConcreteCmsUtility\FileUtility $fileUtility */
/** @var \ConcreteCmsUtility\ImageUtility $imageUtility */
/** @var \ConcreteCmsUtility\VideoUtility $videoUtility */

// Hints for returned objects
/** @var \ConcreteCmsUtility\DTO\FileData $file */
/** @var \ConcreteCmsUtility\DTO\GalleryImageData $image */
/** @var \ConcreteCmsUtility\DTO\ImageData $image */
/** @var \ConcreteCmsUtility\DTO\SliderImageData $image */
/** @var \ConcreteCmsUtility\DTO\VideoeData $video */

// Hints for arrays (when using foreach loop etc.).
/** @var \ConcreteCmsUtility\DTO\ImageData[] $images */

您可以像对象一样访问返回值

$file->url;

$image->url;
$image->width;
$image->height;

$image->file->url;

安装

composer require parasek/concretecms_utility

安装(不使用composer)

下载最新版本,并将src文件夹的内容复制到application/src/ConcreteCmsUtility

application/bootstrap/app.php中添加以下代码

$classLoader = new \Symfony\Component\ClassLoader\Psr4ClassLoader();
$classLoader->addPrefix('ConcreteCmsUtility', DIR_APPLICATION . '/' . DIRNAME_CLASSES . '/' . 'ConcreteCmsUtility');
$classLoader->register();

访问https://github.com/JamesHeinrich/getID3并下载getID3库的最新版本。

将该仓库的内容复制到application/src,并在某处加载它(例如在application/bootstrap/app.php中)。

require_once( DIR_APPLICATION . '/' . DIRNAME_CLASSES . '/getID3/getid3/getid3.php');

服务提供商

您可以在application/config/app.php中的providers部分注册服务提供商

'providers' => [
    'concrete_cms_utility' => ConcreteCmsUtility\ServiceProvider::class,
],

然后您将能够使用简写,例如

app('utils/image')->getPlaceholderString(width: 100, height: 100);
$app->make('utils/file')->getFile(file: 1)->url;
$this->app->make('utils/video')->getVideo(file: 1)->url;

示例用法

如何加载服务

use ConcreteCmsUtility\FileUtility;
use ConcreteCmsUtility\ImageUtility;

// Using Service container in controllers
$fileUtility = $this->app->make(FileUtility::class);
$imageUtility = $this->app->make(ImageUtility::class);

// Using Service container in view files
$app = \Concrete\Core\Support\Facade\Application::getFacadeApplication();
$fileUtility = $app->make(FileUtility::class);
$imageUtility = $app->make(ImageUtility::class);

// Using app helper (everywhere)
$fileUtility = app(FileUtility::class);
$imageUtility = app(ImageUtility::class);

// Using dependency injection
class CustomClass
{
    protected FileUtility $fileUtility;
    protected ImageUtility $imageUtility;

    public function __construct(FileUtility $fileUtility, ImageUtility $imageUtility)
    {
        $this->fileUtility = $fileUtility;
        $this->imageUtility = $imageUtility;
    }
}

示例

<?php
/** @var \ConcreteCmsUtility\ImageUtility $imageUtility */
/** @var \ConcreteCmsUtility\DTO\GalleryImageData $image */

$imageUtility = app(\ConcreteCmsUtility\ImageUtility::class);

$image = $imageUtility->getGalleryImage(
    file: 29,
    width: 300,
    height: 200,
    crop: true,
    alt: 'Custom alt',
    title: 'Custom Title for lightbox etc.',
    fullscreenWidth: 1600,
    fullscreenHeight: 1200,
    fullscreenCrop: false,
);
//dump($image);
?>
<?php if ($image->isValid): ?>
    <a href="<?php echo h($image->fullscreenUrl); ?>"
       title="<?php echo h($image->title); ?>"
    >
        <img src="<?php echo h($image->url); ?>"
             alt="<?php echo h($image->alt); ?>"
             width="<?php echo h($image->width); ?>"
             height="<?php echo h($image->height); ?>"
        >
    </a>
    <a href="<?php echo h($image->file->downloadUrl); ?>"
       title="<?php echo h($image->title); ?>"
    >
        <?php echo t('Download'); ?>
    </a>
<?php endif; ?>