PHPackages                             castlegate/monolith-core - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. castlegate/monolith-core

AbandonedArchivedLibrary[Utility & Helpers](/categories/utility)

castlegate/monolith-core
========================

Basic utilities and functions for PHP development.

v1.1.4(3y ago)0371MITPHP

Since Nov 11Pushed 3y ago2 watchersCompare

[ Source](https://github.com/castlegateit/monolith-core)[ Packagist](https://packagist.org/packages/castlegate/monolith-core)[ RSS](/packages/castlegate-monolith-core/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (7)Used By (1)

Monolith Core Module
====================

[](#monolith-core-module)

Monolith is a collection of utility functions and classes that make PHP and WordPress development a little bit easier. The Core module can be used with any PHP project and uses the `\Castlegate\Monolith\Core` namespace.

Install
-------

[](#install)

Monolith Core is available on [Packagist](https://packagist.org/) and can be installed via [Composer](https://getcomposer.org/):

```
composer require castlegate/monolith-core

```

Functions
---------

[](#functions)

- `contains($haystack, $needle)` Does `$haystack` contain `$needle`? Works with strings and arrays.
- `startsWith($haystack, $needle)` Does `$haystack` start with `$needle`? Works with strings and arrays.
- `endsWith($haystack, $needle)` Does `$haystack` end with `$needle`? Works with strings and arrays.
- `fileSize($file, $decimals = 2)` Return a human-readable file size with units and to a particular number of decimal places.
- `dataUrl($file, $type = null)` Return a base64-encoded data URL from a file path.
- `formatUrl($url, $human = false)` Provided with something that looks like a URL, return a predictable URL with or without its scheme.
- `formatLink($url, $content = null, $attributes = [])` Provided with something that looks like a URL, return a valid HTML link with optional content.
- `formatTel($tel, $human = false, $code = null)` Return a formatted telephone number.
- `formatTelLink($tel, $content = null, $attributes = [], $code = null)` Return a telephone number link.
- `obfuscate($text)` Return a string with characters randomly encoded as HTML entities.
- `obfuscateLink($email, $content = null, $attributes = [])` Return an obfuscated HTML email link.
- `ordinal($number)` Return a number with its appropriate ordinal suffix, e.g. "1st", "2nd", or "3rd".
- `truncate($text, $max, $ellipsis = ' …')` Truncates text to within a particular number of characters, avoiding breaking words.
- `truncateWords($text, $max, $ellipsis = ' …')` Truncates text to within a particular number of words, avoiding breaking words.
- `formatAttributes($attributes)` Converts an associative array into a string containing HTML attributes. Nested arrays are converted into space-separated lists.
- `embedSvg($file, $args = [])` Return the contents of an SVG file stripped of anything that might cause problems when it is embedded in an HTML file. This function uses the `ScalableVectorGraphic` class described below.
- `twitterName($url)` Extract and return a Twitter handle from a valid Twitter URL.
- `splitLines($text)` Split comma- and newline-delimited text (e.g. an address) into array items.
- `rejoinLines($lines, $sep = ', ')` Rejoin lines, either as array or string parsed by `splitLines`, with new delimiter.

Classes
-------

[](#classes)

### ScalableVectorGraphic

[](#scalablevectorgraphic)

The `ScalableVectorGraphic` class sanitizes SVG code for embedding directly in HTML documents. By default, it removes the XML declaration and attempts to add a `viewBox` attribute if one is not already present.

```
$svg = new \Cgit\Monolith\Core\ScalableVectorGraphic;
$svg->parse($code); // import SVG code from string
$svg->load($file); // import SVG code from file

echo $svg->embed(); // return sanitized SVG code
```

You can also use it to remove attributes from the root element and to remove styles from the entire SVG. This may be useful for SVG icons where the fill colour should be set by the document CSS and not the CSS embedded in the SVG code.

```
$svg->removeAttributes('viewBox');
$svg->removeAttributes(['width', 'height']);
$svg->removeStyles('fill');
$svg->removeStyles(['fill', 'stroke']);
```

You can reset the SVG to its original condition using the `reset()` method. You can also return the original source code and the non-sanitized, parsed SVG code using the `embedSourceCode()` and `embedSourceDom()` methods respectively.

You can use the `fill($color)` method to set a fill attribute on the root SVG element. You can also use the `title($title)` method to set a title element for better accessibility.

### TimeSpanner

[](#timespanner)

The `TimeSpanner` class provides a convenient way of calculating and displaying consistently formatted ranges of dates or times. Its constructor sets the start and end dates, performing some sanitization of the input (integers are assumed to be Unix time; everything else gets fed through `strtotime()`).

```
$foo = new \Cgit\Monolith\Core\TimeSpanner($start, $end);

$foo->getStartTime($format); // e.g. "1 January 2010"
$foo->getEndTime($format);
$foo->getRange($formats, $tolerance); // e.g. "1-10 January 2010"
$foo->getInterval($formats, $tolerance); // e.g. "4 seconds" or "10 years"
```

You can set the tolerance in seconds for displaying ranges of times. If the difference between the start and end times is within the tolerance value, they are considered to be the same time.

```
$foo->setDefaultRangeTolerance($seconds);
```

Time formats can be specified when returning a value or as default values for this instance. Formats are specified in the standard PHP date format.

```
$foo->setDefaultTimeFormat('j F Y');
$foo->setDefaultRangeFormats([
    'time' => ['H:i', '–', 'H:i d F Y'],
    'day' => ['d', '–', 'd F Y'],
    'month' => ['d F', '–', 'd F Y'],
    'year' => ['d F Y', '–', 'd F Y'],
]);
```

### Video

[](#video)

The `Video` class takes any approximately valid YouTube or Vimeo URL or embed code and provides access to URLs, embed codes, images, and links.

```
$foo = new \Cgit\Monolith\Core\Video($code);

$foo->url(); // video URL
$foo->image(); // video placeholder image
$foo->embed(); // video iframe embed code
$foo->link(); // HTML image with link to video
$foo->responsiveEmbed(); // iframe embed with responsive wrapper
```

Note that `responsiveEmbed` needs an iframe with width and height attributes to calculate the aspect ratio of the video. Otherwise, videos are assumed to be in 16:9 format.

License
-------

[](#license)

Released under the [MIT License](https://opensource.org/licenses/MIT). See [LICENSE](LICENSE) for details.

###  Health Score

27

—

LowBetter than 47% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~221 days

Recently: every ~276 days

Total

6

Last Release

1318d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2feb1ac070be953a53f8c4d902436a8844884b7d968be6b2bac234e617be614e?d=identicon)[jkhughes](/maintainers/jkhughes)

---

Top Contributors

[![johnkhughes](https://avatars.githubusercontent.com/u/1375434?v=4)](https://github.com/johnkhughes "johnkhughes (7 commits)")

### Embed Badge

![Health badge](/badges/castlegate-monolith-core/health.svg)

```
[![Health](https://phpackages.com/badges/castlegate-monolith-core/health.svg)](https://phpackages.com/packages/castlegate-monolith-core)
```

###  Alternatives

[spatie/laravel-directory-cleanup

This package will remove the expired files from the given directories.

3061.5M7](/packages/spatie-laravel-directory-cleanup)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)