Download the PHP package se7enxweb/expsite-api without Composer

On this page you can find all versions of the php package se7enxweb/expsite-api. 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 expsite-api

Exponential Site API

General description

Exponential Site API (extension name: expsite_api) is a Site API for Exponential CMS (eZ Publish Legacy), ported from netgen/ibexa-site-api. It wraps the native content tree in a small, modern PHP service API that Exponential Layouts and site templates can use, and provides the following capabilities:

The service/value-object split mirrors netgen/ibexa-site-api (LoadService, FilterService, Content and Location values), reimplemented directly on eZContentObject and eZContentObjectTreeNode with no Symfony dependencies.

Features

Exponential Site API provides the following features in detail:

Key classes

Class File Purpose
expSiteApi classes/expsiteapi.php Static facade: content(), location(), filter()
expSiteApiContentService classes/expsiteapicontentservice.php Load content by ID, remote ID, location ID; find
expSiteApiLocationService classes/expsiteapilocationservice.php Load locations, children, parents; find
expSiteApiFilterService classes/expsiteapifilterservice.php findContent() / findLocations() with a query array
expSiteApiContent classes/expsiteapicontent.php Value object wrapping eZContentObject
expSiteApiLocation classes/expsiteapilocation.php Value object wrapping eZContentObjectTreeNode

ContentService

LocationService

FilterService

Query format

Query key defaults: parent_id 2, limit 25, offset 0, sort_by array( 'name', true ). content_type_identifier becomes ClassFilterType=include + ClassFilterArray. findContent() always uses depth 1; only findLocations() honours depth. sort_by is passed straight through as a subTreeByNodeID SortBy value, so any kernel sort field works (name, published, priority, ...).

Value objects

Both provide simple accessor methods and toArray() for JSON output. All loaders return null when nothing is found.

Version

Copyright

License

Exponential Site API is licensed under the GNU General Public License.

The complete license agreement is included in the LICENSE.md file.

Exponential Site API is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License or at your option a later version.

Exponential Site API is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

The GNU GPL gives you the right to use, modify and redistribute Exponential Site API under certain conditions. The GNU GPL license is distributed with the software, see the file LICENSE.md.

It is also available at https://www.gnu.org/licenses/gpl.txt

You should have received a copy of the GNU General Public License along with Exponential Site API in LICENSE.md. If not, see https://www.gnu.org/licenses/.

Using Exponential Site API under the terms of the GNU GPL is free (as in freedom).

For more information or questions please contact [email protected]

Requirements

The following requirements exists for using Exponential Site API extension:

Exponential CMS / eZ Publish Legacy version

PHP version

Other extensions

Installation

Installation is the standard legacy extension procedure: place the extension in extension/expsite_api, activate it via [ExtensionSettings] ActiveExtensions[] (or ActiveAccessExtensions[] for a single siteaccess), regenerate the extension autoloads (the class map lives in autoloads/expsite_api_autoload.php) and clear all caches. There is no configuration; the extension ships no INI settings.

See the complete step-by-step instructions in INSTALL.md.

Usage

Get services through the static facade; expSiteApi returns a fresh service instance per call:

Loading content and locations:

All loaders return null when nothing is found - always check before use. loadChildren() always fetches depth 1 (direct children) and returns an array of expSiteApiLocation.

Filtering - findContent() returns expSiteApiContent[], findLocations() returns expSiteApiLocation[]:

Building a JSON endpoint payload with the value objects:

See doc/USAGE.md for the full verified examples - JSON endpoints, module views with drill-down, Layouts block handlers - and for the customization guide covering all three layers: the settings layer (no INI shipped; tunables travel in the query arrays and belong in your own extension's settings), the template layer (no templates shipped; rendering of the value objects is owned by the calling templates) and the PHP layer (subclassing the services and value objects, overriding toArray(), and wrapping the facade when your subclasses should be returned).

Documentation

Document Description
INSTALL.md Activation and verification instructions
doc/USAGE.md Verified code examples plus the settings / template / PHP customization layers
doc/FAQ.md Answers to the most common questions
doc/TODO.md Known gaps and planned improvements
doc/SUPPORT.md How and where to get help
LICENSE.md The complete GNU General Public License agreement

Troubleshooting

Read the FAQ

Use our support systems


All versions of expsite-api with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0 || ^8.1 || ^8.2 || ^8.3 || ^8.4
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 se7enxweb/expsite-api contains the following files

Loading the files please wait ...