包简介

README 文档

README

This module for Thelia add a customizable carousel on your home page. You can upload you own image and overload the default template in your template for using the carousel.

Installation

Copy the module into <thelia_root>/local/modules/ directory and be sure that the name of the module is Carousel.
Activate it in your thelia administration panel

Usage

In the configuration panel of this module, you can upload as many images as you want.

Hook

The carousel is installed in the "Home page - main area" (home.body) hook.

Loop

Customize images with the carousel loop, which has the same arguments as the image loop. You can define a width, a height, and many other parameters

Input arguments

Argument	Description
width	A width in pixels, for resizing image. If only the width is provided, the image ratio is preserved. Example : width="200"
height	A height in pixels, for resizing image. If only the height is provided, the image ratio is preserved. example : height="200"
rotation	The rotation angle in degrees (positive or negative) applied to the image. The background color of the empty areas is the one specified by 'background_color'. example : rotation="90"
background_color	The color applied to empty image parts during processing. Use $rgb or $rrggbb color format. example : background_color="$cc8000"
quality	The generated image quality, from 0(!) to 100%. The default value is 75% (you can hange this in the Administration panel). example : quality="70"
resize_mode	If 'crop', the image will have the exact specified width and height, and will be cropped if required. If 'borders', the image will have the exact specified width and height, and some borders may be added. The border color is the one specified by 'background_color'. If 'none' or missing, the image ratio is preserved, and depending od this ratio, may not have the exact width and height required. resize_mode="crop"
effects	One or more comma separated effects definitions, that will be applied to the image in the specified order. Please see below a detailed description of available effects. Expected values : gamma:value : change the image Gamma to the specified value. Example: gamma:0.7. grayscale or greyscale : switch image to grayscale. colorize:color : apply a color mask to the image. The color format is $rgb or $rrggbb. Example: colorize:$ff2244. negative : transform the image in its negative equivalent. vflip or vertical_flip : flip the image vertically. hflip or horizontal_flip : flip the image horizontally. example : effects="greyscale,gamma:0.7,vflip"
group	The name of an image group. Return only images from the specified group
filter_disable_slides	if true (the default), the disabled slides will not be displayed

Ouput arguments

Variable	Description
$ID	the image ID
$IMAGE_URL	The absolute URL to the generated image
$ORIGINAL_IMAGE_URL	The absolute URL to the original image
$IMAGE_PATH	The absolute path to the generated image file
$ORIGINAL_IMAGE_PATH	The absolute path to the original image file
$ALT	alt text
$TITLE	the slide title
$CHAPO	the slide summary
$DESCRIPTION	the slide description
$POSTSCRIPTUM	the slide conclusion
$LOCALE	the textual elements locale
$POSITION	the slide position in the carousel
$URL	the related URL
$LIMITED	true if slide is disabled, false otherwise
$START_DATE	limited slide display start date
$END_DATE	limited slide display end date
$DISABLE	true if slide display is limited
$GROUP	name of the group the slide belong to

Exemple

{loop type="carousel" name="carousel.front" width="1200" height="390" resize_mode="borders"}
    <img src="{$IMAGE_URL}" alt="{$ALT}">
{/loop}

How to override ?

If you want your own carousel in your tempalte, create the directory modules/Carousel then create the template carousel.html in this directory. Here you can create your own carousel and the replace the default template provided in the module.

thelia/carousel-module 适用场景与选型建议

thelia/carousel-module 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 44.23k 次下载、GitHub Stars 达 2，最近一次更新时间为 2015 年 01 月 20 日，在 PHP 生态内属于活跃度较高的组件。

我们在过去多个企业项目中使用过 thelia/carousel-module 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 thelia/carousel-module 我们能提供哪些服务？

定制开发 / 二次开发

基于 thelia/carousel-module 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

thelia/carousel-module

包简介