Download the PHP package schoolsfocus/sf-webcontents-api-client without Composer
On this page you can find all versions of the php package schoolsfocus/sf-webcontents-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download schoolsfocus/sf-webcontents-api-client
More information about schoolsfocus/sf-webcontents-api-client
Files in schoolsfocus/sf-webcontents-api-client
Package sf-webcontents-api-client
Short Description A PHP client for interacting with the SchoolsFocus Webcontents API, providing methods to fetch website content, events, media, system data, and website menu.
License MIT
Homepage https://github.com/SchoolsFocus/sf-webcontents-api-client
FAQ
Example:
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 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.
Informations about the package sf-webcontents-api-client
sf-webcontents-api-client
Introduction
The sf-webcontents-api-client is a PHP package designed to provide a simple and convenient way to interact with the SchoolsFocus Webcontents API. This package allows developers to easily fetch website content, events, media, system data, and website menu structures from the Webcontents service. It is framework-agnostic, meaning it can be used with any PHP framework or even in vanilla PHP applications.
Installation
To install the sf-webcontents-api-client, you can use Composer. Run the following command in your terminal:
Usage
Initialization
To use the WebcontentsApiClient, you need to create an instance of the class and provide the API URL and API key.
Fetching Website Content
To fetch website content, use the fetchContent method.
Parameters:
name(string): The exact name of the content item.prefix(string): A prefix to search for content items.id(int): The specific ID of a content item.limit(int): The maximum number of results to return.start(int): The starting offset for pagination.has_uploaded_file(bool|string): Filter for content with an associated file.content_type(string): Filter by type (e.g., 'slider_image', 'page', 'content').
Return Value:
Returns an associative array containing the API response.
Fetching Events
To retrieve events, use the fetchEvents method.
Parameters:
timeline(string): Filter by time ('upcoming', 'past', 'previous').type(string): The type of event ('event', 'blog', 'news', etc.).limit(int): The maximum number of results to return.start(int): The starting offset for pagination.id(int): The specific ID of an event.
Return Value:
Returns an associative array containing the API response.
Fetching Media Gallery
To fetch media items, use the fetchMediaGallery method.
Parameters:
mediaType(string): The type of media ('images', 'videos').limit(int): The maximum number of results to return.start(int): The starting offset for pagination.id(int): The specific ID of a gallery item.
Return Value:
Returns an associative array containing the API response.
Fetching System Data
To retrieve general system configuration and data, use the fetchSystemData method.
Return Value:
Returns an associative array containing the API response.
Fetching Website Menu
To get the navigation menu structure, use the fetchWebsiteMenu method.
Parameters:
menuLevel(string): The level of the menu to fetch ('parent', 'child_level_1', 'child_level_2').parentId(int): The ID of the parent menu item (required for child levels).
Return Value:
Returns an associative array containing the API response.
License
This package is licensed under the MIT License. See the LICENSE file for more details.
