Download the PHP package northeastern-web/pim-fim-adapter without Composer

On this page you can find all versions of the php package northeastern-web/pim-fim-adapter. 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 pim-fim-adapter

pim-fim-adapter

PIM/FIM 2.0 Adapter Composer Package - for PHP and WordPress based websites

Requirements

Installation

Package Install

  1. In the project you're wanting to integrate PIMFIMAdapter to (where your project's composer.json resides), run composer require northeastern-web/pim-fim-adapter.
  2. Add a .env (copy .env.example in .env file) to project's root directory with constants or define constants in your PHP application's config (WordPress wp-config.php).

Development Install

  1. cd into project's root directory.
  2. Run composer install on the command-line/terminal.
  3. Add a .env (copy .env.example in .env file) to project's root directory with constants.

Configuration

This package supports the use of the PHP Dotenv package for setting and reading environment variables. If your PHP project doesn't use Dotenv, declare the variable as a constant (define()) in the application's configuration. In WordPress, this configuration would be the wp-config.php file.

PIM

Environment Variable Description
PIM_ACCESS_TOKEN Provides the Access Token for reading data from the Contentful PIM Space
PIM_SPACE_ID Provides the Space ID for the Contentful PIM Space
PIM_ENVIRONMENT_ID Provides the Environment ID for the Contentful PIM Space (e.g., 'master', 'staging', 'development')

FIM

Environment Variable Description
FIM_ACCESS_TOKEN Provides the Access Token for reading data from the Contentful FIM Space
FIM_SPACE_ID Provides the Space ID for the Contentful FIM Space
FIM_ENVIRONMENT_ID Provides the Environment ID for the Contentful FIM Space (e.g., 'master', 'staging', 'development')

Usage

The PiM/FIM adapter package allows you to quickly query results from Contentful without having to build-up complex queries or know the content model. Each response in the PIM/FIM adapter classes returns a Contentful object, this can be converted to a Laravel collection, JSON, or other formats.

You may see test/fim/index.php and test/pim/index.php, they are testing files that can be used for development and validating or previewing responses for each adapter method.

Contentful Adapter

The ContentfulAdapter.php class file is intended to expose methods that interact with the Contentful API via the Contentful PHP SDK. Each method to get Entries requires a Query object to be passed-in as a parameter. By Default, each Query will automatically resolve reference entries 1 level deep. Additional levels of Link resolution will need to occur via separate get Entry calls

Below is a list of methods available in the Contentful Adapter:

Name Description
getEntries Get entries by custom Query
getEntriesByContentType Get entries by Content Type and custom Query

PIM

Below are a list of methods available in the PIMAdapter class

Name Parameters Description
getAllPrograms N/A List all Programs, no query parameters.
getCollegeList Query $query - optional Lists all or some Colleges by Query. Use Query object to filter by specific id(s)
getLinkedBannerEntriesByEntryId string $entry_id Fetches entries (Programs) linked to Banner entries by matching Banner entry Id ($entry_id/sys.id)
getProgramsByCollege string $college_name, Query $query - optional This method walks backwards from the College Entry to the Banner Entry and finally to the linked Entries attached to the Banner Entry such as a Program Entry. Using the College Entry Id that's found when doing a lookup of Colleges by $college_name, we filter the API by $college[0]['id'] with the ID of the fields.college.sys.id value in the Banner Entry. Finally, we get linked Entries belonging to the Banner entry. This method will only return Program entries as Banner entries are only attached to Program Entries.
getProgramById string $id Fetch Program entry by sys.id
getProgramByName string $name Fetch Program entry by fields.name
getProgramsByLocationName string $name Fetch Programs by linked Location entry's fields.name
getProgramsByMajorName string $major Fetch Programs by linked Banner entry's fields.major
getProgramsByDegreeType string $degreeType Fetch Programs by linked Banner entry's fields.degreeType. Accepts the following values: "CAGS", "Dual Degree", "Master's Certificate", "Professional Doctorate"
getProgramsByUndergradDegreeType string $undergradDegreeType Fetch Programs by linked Banner entry's fields.undergradDegreeType. Accepts the following values: "N/A", "Bachelor's", "Certificate", "Post-Baccalaureate"
getProgramsByCustom Query $query Fetch Programs by Custom Query

FIM

Below are a list of methods available in the FIMAdapter class

Name Parameters Description
getAllProfiles N/A List all Profiles, no query parameters.
getProfileById string $id Fetch Profile entry by sys.id
getProfileByName string name Fetch Profile entry by fields.banner.fields.displayNameInternal
getProfilesByCollege string $college_name Fetch Profile entries by fields.banner.fields.collegeAffiliation
getProfilesByCustom Query $query Fetch Profiles by Custom Query

Responses

Responses are in PHP Array or Contentful ResourceArray. Use the methods attached to ResourceArray to map data to fields.

Utilize the PIM/FIM Models to map content types to plain associative PHP arrays.

Rich Text

You may encounter Rich Text fields in the PHP response. To Convert to HTML, you may need to look into the Contentful\RichText\Renderer class. There's class that can be used within Model classes for rendering Rich Text (RendersRichText).

All versions of pim-fim-adapter with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
ext-json Version *
ext-mbstring Version *
contentful/contentful Version ^7.0
illuminate/support Version ^11.12
vlucas/phpdotenv Version ^5.6
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 northeastern-web/pim-fim-adapter contains the following files

Loading the files please wait ....