Download the PHP package suki/ohara without Composer
On this page you can find all versions of the php package suki/ohara. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package ohara
Short Description Helper class for SMF mods
License MPL-2.0
Homepage http://github.com/MissAllSunday/Ohara
FAQ
Example:
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 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.
Informations about the package 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:
- Needs PHP 7.0 or higher. SMF 2.1.
-
Include it or require it on your own file. You can also use composer:
- Ohara uses 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:
- You need to define the $name property, ideally from a declaration:
$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:
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.
