Download the PHP package tehwave/laravel-shortcodes without Composer

On this page you can find all versions of the php package tehwave/laravel-shortcodes. 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 tehwave/laravel-shortcodes

Informations about the package laravel-shortcodes

Laravel Shortcodes

Simple, elegant WordPress-like Shortcodes the Laravel way.

Build Status

Requirements

The package has been developed and tested to work with the latest supported versions of PHP and Laravel as well as the following minimum requirements:

Version Compatibility

Laravel PHP Branch
11+ 8.2+ master
10 and below 8.1 and below 1.x

Installation

Install the package via Composer.

Usage

Laravel Shortcodes work much like WordPress' Shortcode API.

Creating Shortcodes

Run the following command to place a fresh Shortcode class in your new app/Shortcodes directory.

Output

Each Shortcode class contains a handle method, that you may use to output into the compiling content.

Within the handle method, you may access the attributes and body properties.

[!NOTE]
All values in the attributes array are cast to string type when parsed unless specifically cast to a type via the $casts property.

Naming

The shortcode's tag is derived from the class name to snake_case.

You may specify a custom tag using the tag property or by overwriting the getTag method.

Shortcode tags must be alpha-numeric characters and may include underscores.

Compiling Shortcodes

Run a string through the compiler to parse all shortcodes.

You may specify a list of instantiated Shortcode classes to limit what shortcodes are parsed.

Using Casts

Laravel Shortcodes supports casting attributes to various data types. This can be useful when you need to ensure that the attributes passed to your shortcodes are of a specific type.

Available Casts

Example

To use casts, you need to create a shortcode class and specify the casts in the $casts property.

When you compile content with this shortcode, the attributes will be automatically cast to the specified types.

Accessing Attributes

You can retrieve the attributes as direct properties of the shortcode instance.

Example

I developed Laravel Shortcodes for use with user provided content on gm48.net.

The content is parsed using a Markdown converter called Parsedown, and because users can't be trusted, the content has to be escaped.

Unfortunately, this escapes the attribute syntax with double quotes, but singular quotes can still be used as well as just omitting any quotes.

[!NOTE]
Quotes are required for any attribute values that contain whitespace.

Let's take a look at the following content with some basic Row, Columnand Image shortcodes.

When running the content through the following code:

We can expect to see the following output:

You should still escape any user input within your shortcodes' handle.

Tests

Run the following command to test the package.

Security

For any security related issues, send a mail to [email protected] instead of using the issue tracker.

Changelog

See CHANGELOG for details on what has changed.

Upgrade Guide

See UPGRADING.md for details on how to upgrade.

Contributions

See CONTRIBUTING for details on how to contribute.

Credits

Inspired by https://github.com/webwizo/laravel-shortcodes and https://github.com/spatie/laravel-blade-x

About

I work as a Web Developer in Denmark on Laravel and WordPress websites.

Follow me @tehwave on Twitter!

License

MIT License

All versions of laravel-shortcodes with dependencies

PHP Build Version
Package Version
Requires php Version ^7.2.5|^8.0|^8.1
illuminate/console Version ^6.0|^7.0|^8.0|^9.0|^10.0
illuminate/support Version ^6.0|^7.0|^8.0|^9.0|^10.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 tehwave/laravel-shortcodes contains the following files

Loading the files please wait ....