xs-khairul/pac04

Utility packages for Wpmet plugin, It will be used to serve Stories, Notice , Banner and Ratings

v1.0.0 2023-02-28 06:06 UTC

GPL-3.0-only

• XpeedStudio
• Wpmet

README

#Over View of package

• Wpmet Plugin Utility helper package for Banner , Notice , Stories and Rating.
• We made a composer package for these classes together.
• By using this Helper package we are centralizing the feature of these Classes in a package manager (so that any update or modifications of this functionalities globally no need to give hand or keep any dependencies on our plugins)

Composer and making :

composer is a php dependency manager which take cares of all dependencies of projects , it take care of namespaces initializing and calling by mapping it in its autoload.php file we just need to specify the root dir in its jeson file call composer.json we can also configure its dependencies here and its author and package name etc.

composer.json file example

{
    "name": "xs-khairul/pac04",
    "description": "Utility packages for Wpmet plugin, It will be used to serve Stories, Notice , Banner and Ratings",
    "version": "v1.0.0",
    "type": "library",
    "license": "GPL-3.0-only",
    "autoload": {
        "psr-4": {
            "Wpmett\\UtilityPackage\\": "src/"
        }
    },
    "authors": [
        {
            "name": "XpeedStudio",
            "email": "[e-mail]"
        },
        {
            "name": "Wpmet",
            "email": "[e-mail]"
        }
    ],
    "minimum-stability": "stable",
    "require": {

    },
    "require-dev": {

    }

}

explanation

• namespace "Wpmett\UtilityPackage\" point to the src/ folder directly by composer when it calls
• require if any other package needed for this project.
• required-dev if any other package needed for this project for only development purpose.

to install this package by CLI

composer require xs-khairul/pac04

Using feature example

/**
			 * Show WPMET stories widget in dashboard
			 */
			\Wpmett\UtilityPackage\Stories\Stories::instance( 'elementskit-lite' )
			// ->is_test(true)
			->set_filter( $filter_string )
			->set_plugin( 'ElementsKit', 'https://wpmet.com/plugin/elementskit/' )
			->set_api_url( 'https://api.wpmet.com/public/stories/' )
			->call();


			/**
			 * Show WPMET banner (codename: jhanda)
			 */
			\Wpmett\UtilityPackage\Banner\Banner::instance( 'elementskit-lite' )
			// ->is_test(true)
			->set_filter( ltrim( $filter_string, ',' ) )
			->set_api_url( 'https://api.wpmet.com/public/jhanda' )
			->set_plugin_screens( 'edit-elementskit_template' )
			->set_plugin_screens( 'toplevel_page_elementskit' )
			->call();