imarc / craft-kindling
A Craft plugin and Twig Extension providing some convienences.
Installs: 9 984
Dependents: 1
Suggesters: 0
Security: 0
Stars: 2
Watchers: 24
Forks: 0
Open Issues: 0
Type:craft-plugin
Requires
- php: ^8.0
- craftcms/cms: ^3.0.2 || ^4.0.0
- twig/twig: ^3.3.10
Requires (Dev)
- craftcms/rector: dev-main
This package is auto-updated.
Last update: 2024-10-29 05:04:42 UTC
README
This is a Craft CMS plugin and Twig extension that provides some convienent logic for use building Craft sites.
This plugin has been updated for Craft 3. For Craft 2, please see the craft2 branch and the latest 1.x release.
Array Extension
This adds the twig filter intersect
which simply maps to PHP's own
array_intersect.
Cookie Extension
This add the twig function cookie
which can be used to get or a set a cookie.
If only one parameter is passed, it returns the value of the cookie if it
exists. If more two or more parameters are passed, it has the same parameters
as PHP's own setcookie().
Linkify
A simple twig filter, linkify
, that searches a text string for URLs and email addresses and wraps them in anchor tags. Remember to use the |raw filer on the output.
{{ linkify(tweet.text)|raw }}
Inflection Extension
This add two twig filters: numberToWords
and inflect
.
numberToWords
converts an integer between -999,999,999,999,999,999,999 and
999,999,999,999,999,999,999 into words. It has an optional argument if you'd
like the result to be an adjective.
{{ 432|numberToWords }} returns "four hundred and thirty-two"
{{ 101|numberToWords(true) }} returns "one hundred and first"
inflect
Takes at least one argument, a formatter expression, that it uses
with the quantity. It will try to pluralize the expression automatically, but
you can also provide a second argument to specify the exact plural format.
In the formatter expression, you can use %d
, %n
, %a
, or %%
:
%d
is replaced with the original number.%n
is replaced with the original number written out as words.%a
is replaced with the original number written out as an adjective.%%
is a literal %.
{{ 1|inflect('cat') }}, {{ 2|inflect('cat') }} returns "cat, cats"
{{ 1|inflect('%n fish') }}, {{ 2|inflect('%d grass') }} returns "one fish, 2 grasses"
{{ 3|inflect('%d person') }} returns "3 people"
{{ 22|inflect('%a day', '%a day') }} returns "twenty-second day"
Pathing Variables Extension
Path classes provides a way to get classes generated from the current request path. For example,
- URL: http://example.com/about/company/news
- Using the function:
{{ path_classes() }}
outputsabout company news
- Using the variable:
path_classes
returns an array containingabout
,company
, andnews
- Using the function:
Both of these are designed to be manipulated. The path_classes
function takes
two arguments, $offset
and $length
, and uses
array_slice under the hood:
- URL: http://example.com/about/company/news/Big-Announcement
- Using the function:
{{ path_classes(1) }}
outputscompany news big-announcement
- Using the function:
{{ path_classes(0, 2) }}
outputsabout company
- Using the function:
{{ path_classes(0, -1) }}
outputsabout company news
- Using the function:
{{ path_classes(-1) }}
outputsbig-announcement
- Using the function:
Both $offset
and $length
can be negative (just like array_slice). If you
would rather get and manipulate an array with Twig, you can use path_classes
to get back an array, and then use Twig's syntax for array slicing:
- URL: http://example.com/about/company/news/Big-Announcement
- Using the variable:
{{ path_classes|join(', ') }}
outputsabout, company, news, big-announcement
- Using the variable:
path_classes[:2]
returns an Array containingabout
andcompany
- Using the variable:
Lastly, there is also path_id()
. You can use path_id
as a variable or a function:
- URL: http://example.com/about/company/news/Big-Announcement
- Using the variable:
{{ path_id }}
outputsabout-company-news-big-announcement
- Using the function:
{{ path_id(0, 3) }}
outputsabout-company
- Using the function:
{{ path_id(0, -1) }}
outputsabout-company-news
- Using the variable:
But what about the homepage? Try the ?:
operator.
Putting it all together:
<body class="{{ path_classes }}" id="{{ path_id(0, 3) ?: 'home' }}"> ... </body>
Lastly, if you store whatever you're going to use for the body ID to a
variable, this is probably easier to work with than craft.request.path
to
check whether you're on that page (to say, hide/show parts of a twig layout.)
Wrap Embeds Extension
This is a simple twig filter, wrapembeds
, that searches for <iframe>
tags
in the text passed in, and if it finds any, wraps them in a div with a class of
"responsive_video".
Template Variables
executionTime Outputs the time required for the server to execute the page output
{{ craft.kindling.executionTime }}