Download the PHP package typisttech/wp-option-store without Composer

On this page you can find all versions of the php package typisttech/wp-option-store. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of typisttech/wp-option-store

Informations about the package wp-option-store

WP Option Store

Packagist Packagist PHP from Packagist CircleCI codecov GitHub GitHub Sponsor Sponsor via PayPal Hire Typist Tech Twitter Follow @TangRufus

Extending WordPress Options API, read options from places other than database, the OOP way.

The Goals, or What This Package Does?

WordPress Option API only allows you get_option from database. This package is for those who not accepting the status quo.

Install

Installation should be done via composer, details of how to install composer can be found at https://getcomposer.org/.

You should put all WP Option Store classes under your own namespace to avoid class name conflicts.

Usage

Example

ConstantStrategy

This strategy gets options from PHP constants.

DatabaseStrategy

This strategy gets options from WordPress Options API.

Important: An unset value should be null instead of WordPress' default false.

OptionStore

This class gets option values from strategies.

__construct(StrategyInterface ...$strategies)

OptionStore constructor.

Note: Strategies order matters!

get(string $optionName)

Get an option value.

Type casting

OptionStore provides several helper methods for type casting.

FilteredOptionStore

This is a subclass of OptionStore.

get(string $optionName)

Get an option value.

Note: Filters are applied before type casting.

Factory

Factory is a helper class to reduce boilerplate code for those who use default strategies. If you use a reorder the strategies, don't use this class.

build(): FilteredOptionStore

Frequently Asked Questions

Can I implement my own strategy classes?

Of course! Just implements the StrategyInterface.

Take a look at classes ConstantStrategy and DatabaseStrategy as well as their tests for example implementations of StrategyInterface.

If you'd like to create a open-source package to do this to help others, open a new issue to let us know, we'd love to help you with it.

Can I change the order of the strategies?

Why not? Don't use Factory.

Is this a plugin?

No, this is a package that should be part of your plugin.

What to do when wp.org plugin team tell me to clean up the vendor folder?

Re-install packages via the following command. This package exports only necessary files to dist.

Can two different plugins use this package at the same time?

Yes, if put all WP Option Store classes under your own namespace to avoid class name conflicts.

Do you have real life examples that use this package?

Here you go:

Add your own plugin here

Will you add support for older PHP versions?

Never! This plugin will only work on actively supported PHP versions.

Don't use it on end of life or security fixes only PHP versions.

It looks awesome. Where can I find some more goodies like this?

Where can I give :star::star::star::star::star: reviews?

Thanks! Glad you like it. It's important to let my know somebody is using this project. Since this is not hosted on wordpress.org, please consider:

Sponsoring :heart:

Love WP Option Store? Help me maintain it, a sponsorship here can help with it.

GitHub Sponsors Matching Fund

Do you know GitHub is going to match your sponsorship?

Sponsor now via GitHub to double your greatness.

Why don't you hire me?

Ready to take freelance WordPress jobs. Contact me via the contact form here or, via email [email protected]

Want to help in other way? Want to be a sponsor?

Contact: Tang Rufus

Running the Tests

Run the tests:

Feedback

Please provide feedback! We want to make this project useful in as many projects as possible. Please submit an issue and point out what you do and don't like, or fork the project and make suggestions. No issue is too small.

Change log

Please see CHANGELOG for more information on what has changed recently.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

WP Option Store is a Typist Tech project and maintained by Tang Rufus, freelance developer for hire.

Full list of contributors can be found here.

License

The MIT License (MIT). Please see License File for more information.

All versions of wp-option-store with dependencies

PHP Build Version
Package Version
Requires php Version >7.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package typisttech/wp-option-store contains the following files

Loading the files please wait ....