README

Carbon.Eel Package for Neos CMS

BEM Helper

Generates BEM classes. The modifiers property can be a string (for one modifier), an array (e.g. ['one', 'two']), or an array with keys and values. If you have an array with keys and values (like a Fusion DataStructure) and a value is true, the key's name gets used for the modifier.

block (string, required) The name of the block
element (string) The name of the element, optional
modifiers (string|array) The name of the modifiers, optional

`BEM.array(block, element, modifiers)`

Shortcut to Carbon.Array.BEM(block, element, modifiers)

`BEM.string(block, element, modifiers)`

Shortcut to Carbon.String.BEM(block, element, modifiers)

`BEM.modifier(class, modifiers)`

Generates a string with BEM classes. The modifiers property can be a string (for one modifier), an array (e.g. ['one', 'two']), or an array with keys and values. If you have an array with keys and values (like a Fusion DataStructure) and the value is true, the key's name gets used for the modifier.

class (string, required) The name of the class
modifiers (string|array) The name of the modifiers, optional

Return The string

Array Helper

`Carbon.Array.BEM(block, element, modifiers)`

Generates an array with BEM classes. The modifiers property can be a string (for one modifier), an array (e.g. ['one', 'two']), or an array with keys and values. If you have an array with keys and values (like a Fusion DataStructure) and the value is true, the key's name gets used for the modifier.

block (string, required) The name of the block
element (string) The name of the element, optional
modifiers (string|array) The name of the modifiers, optional

Return The array

`Carbon.Array.chunck(array, length, preserveKeys)`

Chunks an array into arrays with length elements. The last chunk may contain less than length elements.

array (array, required) The array to work on
length (integer, required) The size of each chunk
preserveKeys (bool) When set to true, keys will be preserved. Default is false, which will reindex the chunk numerically

`Carbon.Array.join(array, separator)`

Join the given array recursively using the given separator.

${Carbon.Array.join(array, ',')}

array (array) The array that should be processed
separator (string, optional) The separator between the values defaults to ,

Return The converted array as a string

`Carbon.Array.extractSubElements(array, preserveKeys)`

This method extracts sub-elements to the parent level.

An input array of type:

[
 element1 => [
   0 => 'value1'
 ],
 element2 => [
   0 => 'value2'
   1 => 'value3'
 ],

will be converted to:

[
   0 => 'value1'
   1 => 'value2'
   2 => 'value3'
]

array (array) The array that should be processed
preserveKeys (boolean, optional) Option if the key should be preserved, defaults to false

Return The converted array

`Carbon.Array.intersect(array1, array2, array_)`

array1 (iterable|mixed) First array or value
array2 (iterable|mixed) Second array or value
array_ (iterable|mixed, optional) Optional variable list of additional arrays / values

Returns an array containing all the values of array1 that are present in all the arguments.

`Carbon.Array.length(array)`

The method counts elements of a given array or a countable object. Return 0 if it is not an countable object.

count = ${Carbon.Array.length(countable)}

`Carbon.Array.hasKey(array, key)`

Returns a boolean if the array has a specific key

bool = ${Carbon.Array.hasKey(array, key)}

`Carbon.Array.hasValue(array, value)`

Returns a boolean if the array has a specific value

bool = ${Carbon.Array.hasValue(array, value)}

`Carbon.Array.getValueByPath(array, path)`

Returns the value of a nested array by following the specified path.

value = ${Carbon.Array.getValueByPath(array, path)}

`Carbon.Array.setValueByPath(array, path)`

Sets the given value in a nested array or object by following the specified path.

array = ${Carbon.Array.setValueByPath(subject, path, value)}

`Carbon.Array.check(variable)`

Check if a variable is iterable and has items

Return The variable or null if it is empty or not an iterable

`Carbon.Array.isCountable(variable)`

Check if the given variable is countable

Return true or false

`Carbon.Array.sortByItem(array, key, direction)`

array (iterable|mixed) array with arrays to sort
key (string) Key of array to sort
direction (string, optional) ASC or DESC. Direction of sorting

Return The sorted array

Date Helper

`Carbon.Date.secondsUntil(string)`

Return seconds until the given offset. . Very useful for maximumLifetime on the @cache entry.

string (string) The offset in DateInterval format starting from midnight
dateinerval (boolean, optional) true if interval should be used or the $offset should be parsed, defaults to true

In this example, we clear the cache at midnight by adding an offset of 0 hours.

@cache {
    mode = 'cached'
    maximumLifetime = ${Carbon.Date.secondsUntil('PT0H')}
    ...
}

To get the seconds until next year, you can do it like this:

secondUntilNextYear = ${Carbon.Date.secondsUntil('first day of January next year', false)}

Return The timespan in seconds (integer)

`Carbon.Date.timeToDateInterval(string)`

Convert time duration (1:00) into a DateInterval

Return The duration as DateInterval

FileContent Helper

`Carbon.FileContent.path(string)`

Returns the file content of a path. Fails silently.

Examples:

Carbon.FileContent.path('resource://Foo.Bar/Private/Assets/Logo.svg')
Carbon.FileContent.path('Foo.Bar/Private/Assets/Logo.svg')

string (string) The path to the file

Return The content of the file

`Carbon.FileContent.pathHash(string, length)`

Returns the hash value from the file content of a path. Fails silently.

Examples:

Carbon.FileContent.pathHash('resource://Foo.Bar/Private/Assets/Logo.svg') == 1d62f5a5
Carbon.FileContent.pathHash('Foo.Bar/Private/Assets/Logo.svg', 20) == 1d62f5a55ad5e304d60d

string (string) The path to the file
length (integer, optional) The length of the hash value defaults to 8. The maximal value is 40

Return The hash value from the content of the file

`Carbon.FileContent.resource(resource)`

Returns the file content of a persisted resource. Fails silently.

Example:

Carbon.FileContent.resource(q(node).property('file'))

resource (resource) The persisted resource to read

Return The content of the file

`Carbon.FileContent.resourceHash(resource, length)`

Returns the hash value from the file content of a persisted resource. Fails silently.

Example:

Carbon.FileContent.resourceHash(q(node).property('file')) == 1d62f5a5
Carbon.FileContent.resourceHash(q(node).property('file'), 20) == 1d62f5a55ad5e304d60d

resource (resource) The persisted resource to read
length (integer, optional) The length of the hash value defaults to 8. The maximal value is 40

Return The hash value from the content of the file

String Helper

`Carbon.String.BEM(block, element, modifiers)`

block (string, required) The name of the block
element (string) The name of the element, optional
modifiers (string|array) The name of the modifiers, optional

Return The string

`Carbon.String.urlize(string)`

Generates a slug of the given string

Examples:

Carbon.String.urlize('Hello World') == 'hello-world'
Carbon.String.urlize('Ä_ÖÜ äöü') == 'ae-oeue-aeoeue'

string (string) The string to convert