Download the PHP package nikolag/laravel-square without Composer

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

Informations about the package laravel-square

Test Coverage Build and test PHP 8.x Latest Stable Version License

Square integration with Laravel/Lumen >=5.5 built on nikolag/core

  1. Version Compatibility
  2. Installation guide
  3. Customer System
  4. Order System
  5. Examples
  6. Available methods
  7. Contributing
  8. License

Version Compatibility

Old square connect api

Library Version Laravel Version Square Connect Version
2.3.x   >= 5.5 2.20190814 (Square Connect V1)
2.4.x   >= 6.x 2.20190925.0 (Square Connect V2)
2.5.x   >= 7.x 2.20190925.0 (Square Connect V2)
2.6.x   >= 8.x 3.20200528.1 (Square Connect V2)

New square sdk

Library Version Laravel Version Square SDK Version
3.0.x   >= 8.x 17.0.0.20211215
3.1.x   >= 9.x 25.1.0.20230119
3.2.0   >= 10.x 25.1.0.20230119
3.2.x   >= 10.x 29.0.0.20230720

If you are updating from versions below 3.0 then you need to execute: php artisan migrate. This will add some columns required by the library into the tables created by the library, your own tables won't be affected.

Installation guide

composer require nikolag/laravel-square

Note: Due to Laravel Package Discovery, registering service providers and facades manually for this project as of Laravel 5.5 is deprecated and no longer required since the package is adapted to automatically register these stuff for you. But there are still couple of steps to do in order to use this package.

First you have to publish configuration files:

Check configuration files out at config/nikolag.php before continuing.

Important: If for some reason you can't see square driver inside of connections array, you'll have to add it manually. You can find configuration file here and copy everything from inside connections array and append to your connections array inside of published config file (config/nikolag.php)

nikolag configuration
Figure 1. Config file

After finishing with configuration files, you should run migrations with the following command

Then add your credentials for Square API inside of .env and also add fully qualified name (namespace) for your classes.

Customers system

To be able to utilize the customers system for Users, your User class must use HasCustomers trait.

You also need to define user namespace

Orders system

To be able to utilize the order system for Users, your Order class must use HasProducts trait and define $table property.

You also need to define a couple of environment variables

Important: SQUARE_PAYMENT_IDENTIFIER represents the name of the column where we will keep the unique ID that Square generates once it saves an Order. This means that you will need to add a new column to your Orders table which will hold that value.

Examples

Simple examples

Simple examples are moved to wiki pages to avoid unnecessary scrolling of README.md.

Examples with customers

Examples with customers are moved to wiki pages to avoid unnecessary scrolling of README.md.

Examples with order

Examples with orders are moved to the wiki pages to avoid unnecessary scrolling of README.md.

All traits and their methods

HasProducts

All methods for this trait are moved to the wiki pages to avoid unnecessary scrolling of README.md.

HasCustomers

All methods for this trait are moved to the wiki pages to avoid unnecessary scrolling of README.md.

All facades and their methods

Square

All methods for this facade are moved to the wiki pages to avoid unnecessary scrolling of README.md.

Contributing

Everyone is welcome to contribute to this repository, simply open up an issue and label the request, whether it is an issue, bug or a feature. For any other inquiries send an email to [email protected]

Contributors

Name Changes Date
@Godlikehobbit Add optional currency parameter to charge function pull request #6 2017-09-12
@PaulJulio Cap square/connect version to resolve deprecation exceptions pull request #27 2019-09-20
@Alex Oleynik Fixes TypeError when updating customers pull request #71 2022-06-28
@qooplmao Adds support for 3DS/SCA pull request #74 2023-01-13

Special thanks to all of the contributors!

License

MIT License

Copyright (c) Nikola Gavrić [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

All versions of laravel-square with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
doctrine/dbal Version ^3.5
illuminate/config Version 10.x
illuminate/console Version 10.x
illuminate/container Version 10.x
illuminate/contracts Version 10.x
illuminate/database Version 10.x
illuminate/filesystem Version 10.x
illuminate/support Version 10.x
nikolag/core Version 2.8.x
square/square Version 29.0.0.20230720
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 nikolag/laravel-square contains the following files

Loading the files please wait ....