A DustPress plugin that provides a handy JavaScript library for using your DustPress Model methods on the front end.
JavaScript PHP
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
js
CHANGELOG.html
CHANGELOG.md
LICENSE
README.html
README.md
composer.json
plugin.php

README.md

geniem-github-banner

DustPress Plugin: DustPress.js

A DustPress plugin that provides a handy JavaScript library for using your DustPress model methods on the front end.

Usage

You can call for SomeModel's method SomeMethod with following code:

dp("SomeModel/SomeMethod", {
	tidy: true,
	args: {
		'foo': 'bar'
	}
	success: function( data ) {
		// do what you want with the data
	},
	error: function( error ) {
		// possible error
	}
});

tidy: true parameter cleans up the data tree a bit for more usability. Feel free to try the queries with and without it to see the difference.

args parameter passes arguments to the PHP side. They can be accessed there with $this->get_args();.

If you want, you can even render HTML with Dust templates.

dp( 'SomeModel/SomeMethod', {
	partial: 'SomePartial',
	success: function( data ) {
		// do what you want with the data
	},
	error: function( error ) {
		// possible error
	}
});

This code takes the data of SomeMethod and renders it with SomePartial. Variable data then contains the ready html.

If you still want to get the data output as well, use argument data: true and you will get the resulting data as the second parameter of your success function.

You can also omit the method completely if you want to get the data of a complete model.

dp( 'SomeModel', {
	success: function( data ) {
		// do what you want with the data
	},
	error: function( error ) {
		// possible error
	}
});

If you want to call several functions but not all at once, you can do so by replacing the method's name on the call with a comma-separated list.

dp( 'SomeModel/SomeMethod,AnotherMethod', {
	success: function( data ) {
		// data.SomeMethod and data.AnotherMethod contain the return values
	},
	error: function( error ) {
		// possible error
	}
});

Now data will consist of an object with the methods' names as keys and their return values as the values. Obviously you can also render that to HTML as well.

Additional parameters

bypassMainQuery

By default DustPress.js requests bypass WordPress' main WP_Query so that it wouldn't slow the request down when it's not necessary. You can prevent that from happening by setting bypassMainQuery: false if you want to use the default query.

Note: Since version 2.2.0 DustPress.js calls have been made to the home url instead of current page and thus the default query will reflect that as well. You can point the query to the right page by giving url: window.location parameter to your request.

Model function front-end visibility

You need to make your methods accessible for DustPress.js by defining a property named $api in your model. It should be an array consisting of the names of your accessible methods. DustPress.js can also run protected methods which are not automatically run by DustPress normally.

class SomeModel extends DustPressModel {
    public $api = [
        'SomeMethod'
    ];

    protected function SomeMethod() {
        // Some code..
    }
}

If you need to determine whether a call has been made from ajax or not, you can use dustpress()->is_dustpress_ajax() function like shown below:

class SomeModel extends DustPressModel {
    public $api = [
        'PublicMethod'
    ];

    public function PublicMethod() {
        if ( dustpress()->is_dustpress_ajax() ) {
            // Do not run if this an ajax request.
            return;
        }
        // Some code..
    }
}

Install

Recommended installation to a WordPress project is through composer:

$ composer require devgeniem/dustpress-js

Obviously you can also download the ZIP file from GitHub and extract it into your plugins directory.