Download the PHP package besnovatyj/yii2-cms-shortcode without Composer

On this page you can find all versions of the php package besnovatyj/yii2-cms-shortcode. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of besnovatyj/yii2-cms-shortcode

Informations about the package yii2-cms-shortcode

Пример использования

(NB: Модули тоже могут регистрировать свои шорткоды, например, в методе Module::init())

  1. Конфигурация компонента (в config/web.php):

  2. Регистрация шорткодов:

  3. Использование в контенте:

    Результат:

    • %siteName% → My Site.
    • %homeUrl% → https://example.com.
    • %unknown% → %unknown% (исходная строка, так как шорткод не зарегистрирован).
    • [gallery, id=123, title="Photos", count=5]Photos[/gallery] → Вызов GalleryWidget с параметрами id => 123 (число), title => "Photos", count => 5 (число) и внутренним контентом Photos.
    • [unknown, id="1"] → [unknown, id="1"] (исходная строка, так как виджет не зарегистрирован).

Дополнительные замечания

  1. Числовые значения:

    • В текущей реализации числовые значения преобразуются в int. Если нужны числа с плавающей точкой (например, price=19.99), можно изменить условие в parseAttributes на:
  2. Админка:
    • Для управления текстовыми шорткодами создайте модель и контроллер, чтобы загружать шорткоды через loadTextShortcodes.

  3. Логирование:

    • Если нужно отслеживать неизвестные шорткоды, добавьте логирование:
  4. Производительность:
    • Для больших текстов рассмотрите кэширование результатов обработки шорткодов с помощью \Yii::$app->cache.

Виджет-справочник ShortcodesList

Кнопка, открывающая модалку со всеми доступными шорткодами: описание, готовый пример вставки с кнопкой «копировать» и мелкой подсказкой — чем шорткод заменяется. Смысл в том, чтобы копировать пример прямо из формы редактирования контента, не уходя в модуль шорткодов.

Что внутри модалки:

Всё, что относится к виджету, лежит в src/widgets/shortcodesList/: класс, views/, assets/ и media/ с исходниками и бандлом. Клиентская часть — TypeScript, сборка ESBuild:

Кэш каталога шорткодов

Шорткоды читаются из БД один раз и живут в кэше (APCu) одним элементом с тегом shortcodes — см. services/ShortcodeCatalog. Из этого кэша берут данные и компонент shortcode (замены на горячем пути рендера контента), и виджет-справочник.

Инвалидация автоматическая: ShortcodeManageService сбрасывает тег при создании, изменении и удалении шорткода. Вручную кэш сбрасывается из модуля очистки (ClearManager) — строка «Кэш каталога шорткодов»; эндпойнты объявлены в config/config.php (params.endpoints.clear), обработчик — controllers/backend/ClearController. Жёсткой зависимости от ClearManager нет: без него параметры просто никем не читаются.

All versions of yii2-cms-shortcode with dependencies

PHP Build Version
Package Version
Requires besnovatyj/yii2-cms-kernel Version ^1.2
besnovatyj/yii2-cms-contracts Version ^3.0
php Version >=8.4
yiisoft/yii2 Version ~2.0.0
yiisoft/yii2-bootstrap5 Version ~2.0.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package besnovatyj/yii2-cms-shortcode contains the following files

Loading the files please wait ...