PHPackages                             suki/ohara - 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. suki/ohara

ActiveSmf-module[Utility & Helpers](/categories/utility)

suki/ohara
==========

Helper class for SMF mods

v1.0.6(10y ago)1694[4 issues](https://github.com/MissAllSunday/Ohara/issues)MPL-2.0PHPPHP >=5.3.0

Since Feb 24Pushed 2y ago1 watchersCompare

[ Source](https://github.com/MissAllSunday/Ohara)[ Packagist](https://packagist.org/packages/suki/ohara)[ Docs](http://github.com/MissAllSunday/Ohara)[ RSS](/packages/suki-ohara/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (7)Dependencies (1)Versions (11)Used By (0)

Ohara [![Build Status](https://camo.githubusercontent.com/f1966e6ebe573d256893b9b475bb6eb0bf293ff29b6704f5b82e25f3bc8fe8f4/68747470733a2f2f7472617669732d63692e6f72672f4d697373416c6c53756e6461792f4f686172612e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/MissAllSunday/Ohara)
==============================================================================================================================================================================================================================================================================================

[](#ohara--)

A helper class to be used by SMF modifications (Mods).

#### To be able to use this helper class you need to follow some requirements:

[](#to-be-able-to-use-this-helper-class-you-need-to-follow-some-requirements)

- Needs PHP 7.0 or higher. SMF 2.1.
- Include it or require it on your own file. You can also use composer:

```
$ composer require suki/ohara
```

- Ohara uses [composer/installers](https://github.com/composer/installers) this means the class will be automatically placed inside SMF's Sources folder unless you overwrite it on your own composer.json file.

To use this helper simply extend the parent class Ohara using the Suki\\Ohara namespace:

```
class YourClass extends Suki\Ohara
{
...
```

- You need to define the $name property, ideally from a declaration:

    ```
    ```

public static $name = CLASS;

```

$name is the unique identifier for your main class. Can be any name but usually "__CLASS__" fits quite well.

- You need to call $this->setRegistry(), ideally on your construct method to register your class, have access to several SMF's global variables, create Pimple's service and execute any "on-the-fly" hook declarations.

Thats it, you now have all the power of Ohara. All services are stored as keys in your $this var:

$parsedText = $this['tools']->parser($text, $replacements);

- The class can largely be used as it is but some methods expects info provided by the mod author.

- All your settings ($modSettings) and text strings ($txt) must follow the same pattern:

```php
   $txt['Mod_something'];
   $modSetting['Mod_something'];

```

Where Mod is whatever you used in your $name property.

To be able to use a setting you simply call $this->setting('something'); or $this->text('something'); for a text string. Both values return false if there isn't a $modSetting or $txt associated with it.

$this->setting('something') also accepts a second argument to provide a fallback incase the $modSetting doesn't exists:

$something = $this->setting('something', 'not found!');

- Ohara is named after One Piece island: [Ohara](http://onepiece.wikia.com/wiki/Ohara).

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance0

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 94.6% 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 ~224 days

Recently: every ~313 days

Total

8

Last Release

2527d ago

Major Versions

v1.0.6 → 2.1.x-dev2019-06-16

PHP version history (2 changes)v1.0PHP >=5.3.0

2.1.x-devPHP >=7.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/e21c5a73ddba8a78fd9f1cbfbdce1417826370bc208e1f3b3ec95bcaf0ba48af?d=identicon)[MissAllSunday](/maintainers/MissAllSunday)

---

Top Contributors

[![MissAllSunday](https://avatars.githubusercontent.com/u/3420756?v=4)](https://github.com/MissAllSunday "MissAllSunday (176 commits)")[![live627](https://avatars.githubusercontent.com/u/431799?v=4)](https://github.com/live627 "live627 (10 commits)")

---

Tags

composersmfsmf-modificationsSMFmodifications

### Embed Badge

![Health badge](/badges/suki-ohara/health.svg)

```
[![Health](https://phpackages.com/badges/suki-ohara/health.svg)](https://phpackages.com/packages/suki-ohara)
```

###  Alternatives

[rainlab/blog-plugin

Blog plugin for October CMS

17257.7k](/packages/rainlab-blog-plugin)[rainlab/builder-plugin

Builder plugin for October CMS

17147.2k1](/packages/rainlab-builder-plugin)[pfefferle/wordpress-activitypub

The ActivityPub protocol is a decentralized social networking protocol based upon the ActivityStreams 2.0 data format.

5671.4k1](/packages/pfefferle-wordpress-activitypub)[civicrm/civicrm-drupal-8

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

18238.1k2](/packages/civicrm-civicrm-drupal-8)[mediawiki/semantic-glossary

A terminology markup extension with a Semantic MediaWiki back-end

1352.4k](/packages/mediawiki-semantic-glossary)[humanmade/lottie-lite

A lightweight Lottie Animations Extension for WordPress

374.3k](/packages/humanmade-lottie-lite)

PHPackages © 2026

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