Download the PHP package garchicms/garchi-sdk-php without Composer

On this page you can find all versions of the php package garchicms/garchi-sdk-php. 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?

Informations about the package garchi-sdk-php

GarchiCMS PHP SDK

The GarchiCMS PHP SDK is a PHP package for interacting with the Garchi CMS API. It provides a simple, modular, and intuitive interface for managing categories, data items, reviews, reactions, spaces, and headless CMS features.

πŸ“– API Documentation: Garchi CMS API Docs


πŸ“– Table of Contents


Features


Installation

Using Composer

Usage

This SDK is a wrapper around the Garchi CMS API, providing easy-to-use modular functions that map directly to API endpoints.

Initializing the SDK

Once installed, you can use the SDK without manually requiring files, thanks to Composer's autoloading.

Module Mapping

Each module corresponds to a specific API group:

Each module’s return values correspond to the return value of the respective API endpoint. The only difference is that for non-paginated API endpoints, each module’s return value can be accessed without the .data attribute.

Example Usages

Here are some example usages

Data Item API

Create a Data Item

Update a published item

Visitors keep seeing a published item while it changes: an update to it is kept as unpublished changes unless make_public is true. updateWithStatus() tells you which happened.

Metadata changes to a published item are kept with its unpublished changes too, and an entry added there has a negative meta_id until it is published.

Get All Items

Query items by their fields and metadata

Items inside items (variants, lessons)

A data item can sit inside another one, such as a variant inside its product or a lesson inside its course. Every item has parent_id and children_count; pass 'children' => 'include' to get the items inside as well.

Category API

Create a Category

Get All Categories

Review API

Create a Review

Reaction API

Add or Update Reaction

Space API

Create a Space

List Pages in a Space

List Section Templates in a Space

Compound Query API

Perform a Compound Query

Headless CMS API

Get a Page

Error Handling

All API calls throw exceptions if the API call fails.

Types and Interfaces

The SDK provides structured PHP classes for better type hinting and autocompletion.

Contributing

Feel free to submit issues and pull requests to improve the SDK.

License

This project is licensed under the MIT License.


All versions of garchi-sdk-php with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
guzzlehttp/guzzle Version ^7.9
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 garchicms/garchi-sdk-php contains the following files

Loading the files please wait ...