Download the PHP package belniakmedia/craft-excerptify without Composer

On this page you can find all versions of the php package belniakmedia/craft-excerptify. 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 belniakmedia/craft-excerptify

Informations about the package craft-excerptify

Excerptify Plugin for CMS 3.x

Provides the excertify twig filter which truncates the provided variable's text or html to the nearest whole word based on the provided character length.

Parameters

Parameter Type Default Description
$characterCount int 200 Number of characters to limit result to.
$forceBreakWord bool false When false, the text will be broken at the last occurring word break character. When true it will return the text up to the exact character limit, breaking a word if necessary.
$allowedTags null|string|array null A string representing a single HTML tag or an array of strings representing HTML tags. Added in 5.0.2
$trim bool false When enabled, will remove any non unicode letter or number characters at the end of the returned excerpt. If no visible text was was removed, then the trim does not occur. If HTML was allowed and left in when parsing the content, the > character is also allowed when trimming would otherwise occur. Added in 5.0.3

Usage Examples

Prevent certain HTML tags from being stripped from the output

Pass a string or array of strings to the third parameter representing the tags that should not be removed:

This is a new feature as of 5.0.2

Trim left-over punctuation characters from the end of the returned excerpt

Set the 4th parameter ($trim) to true:

NOTE: Trimming is only performed, when enabled, if visible text was removed. Any non Unicode safe letter or number will be removed from the end. When HTML was allowed and left in for the text being processed, the end HTML character > is also allowed as to not accidentally scenarios where the text ended with an allowed HTML tag.

Enabling this feature will allow you to add your own ellipsis (...) after the excerpt in your use-case without fear of ending up with something like however,... which would be undesirable.

This is a new feature as of 5.0.3

WARNING:
If no visible text was removed then full string less non-allowed html tags will be returned and the trim will not occur. In this case, if the text you passed in ended with a period, the period will be retained in the output. You should test for this before blindly adding your ellipsis or other punctuation. I recommend two ways to accomplish this:

  1. Get two copies of the excerpt from the filter where one uses a very high character count to ensure no text is removed, and also get your actual excerpt. You can compare the raw lengths of the values to determine if content was trimmed and handle it as needed:

  2. Use a regex match to check if a non-word character is present at the end of the excerpt:



Break at nearest word

This is the default as in the same sas passing no arguments. Will return full words and the resulting string will not exceed 200 characters.

To break exactly at the specified character count, even mid word, pass true for the forceBreakWord parameter:

Brought to you by Belniak Media Inc.

All versions of craft-excerptify with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0.2
craftcms/cms Version ^4.0|^5.0
ext-dom Version *
ext-mbstring Version *
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 belniakmedia/craft-excerptify contains the following files

Loading the files please wait ...