Download the PHP package raynl/bizzcloud-laravel without Composer

On this page you can find all versions of the php package raynl/bizzcloud-laravel. 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 raynl/bizzcloud-laravel

Informations about the package bizzcloud-laravel

Bizzcloud for Laravel

This package makes it easy to communicate with Bizzcloud. Latest Version

Latest Version Total Downloads

Setup

Install the package in your Laravel project using composer:

Env

After the package is installed you need to set the following env variables:

BIZZ_URL

The server url is the instance’s domain (e.g. https://mycompany.bizzcloud.nl).

BIZZ_DB

the database name is the name of the instance (e.g. mycompany)/

BIZZ_USERNAME

You can create or use a existing user with enough rights to access the different documents.

BIZZ_PASSWORD

Password of the user.

Here's and example:

Publish configuration

If you want to edit the configuration file you can publish it.

How it works

You create a new instance of Bizzcloud.

After that you can use different methods.

Available methods

List records

Records can be listed and filtered via search().

search() takes a mandatory domain filter (possibly empty), and returns the database identifiers of all records matching the filter. To list customer companies for instance.

If you want with pagination add $offset and $limit.

Count records

Rather than retrieve a possibly gigantic list of records and count them, searchCount() can be used to retrieve only the number of records matching the query. It takes the same domain filter as search() and no other parameter.

If you want with pagination add $offset and $limit.

Read records

Record data is accessible via the read() method, which takes a list of ids (as returned by search()) and optionally a list of fields to fetch. By default, it will fetch all the fields the current user can read, which tends to be a huge amount.

Listing record fields

getFields() can be used to inspect a model’s fields and check which ones seem to be of interest.

Because it returns a large amount of meta-information (it is also used by client programs) it should be filtered before printing, the most interesting items for a human user are string (the field’s label), help (a help text if available) and type (to know which values to expect, or to send when updating a record)

Search and read

Because it is a very common task, BizzCloud provides a searchAndRead() shortcut which as its name suggests is equivalent to a search() followed by a read(), but avoids having to perform two requests and keep ids around.

Its arguments are similar to search()‘s, but it can also take a list of fields (like read(), if that list is not provided it will fetch all fields of matched records)

Create records

Records of a model are created using create(). The method will create a single record and return its database identifier.

create() takes a mapping of fields to values, used to initialize the record. For any field which has a default value and is not set through the mapping argument, the default value will be used.

Update records

Records can be updated using update(), it takes a list of records to update and a mapping of updated fields to values similar to create().

Multiple records can be updated simultanously, but they will all get the same values for the fields being set. It is not currently possible to perform “computed” updates (where the value being set depends on an existing value of a record).

Delete records

Records can be deleted in bulk by providing their ids to delete().

Products

If you have products there is a class only for products.

There are two methods available.

Get all products

Get all of the products. It use the model product.template.

Get specified fields:

Get offset and limit:

Get specified fields, offset and limit

Get a specific product of it's id

Get a specific product of it's id. It use the model product.template.

All versions of bizzcloud-laravel with dependencies

PHP Build Version
Package Version
Requires darkaonline/ripcord Version ^0.1.8
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 raynl/bizzcloud-laravel contains the following files

Loading the files please wait ....