Elentra Platform Technical Documentation
  • Introduction
  • Reporting Issues
    • Security Notices
  • Administrators
    • Server Requirements
    • Application Server
      • Shibboleth Single Sign-on
      • Installing Supervisor
      • Branded API Setup
      • Installing Mailhog
    • Database Server
  • Developers
    • Getting Started
    • Overview
    • Contributions
      • Request for Change
      • Jira and GitHub Details
      • Coding Standards
      • Quickstart Guide
      • Code Review
    • Database
    • Dataviews for Analytics
    • Global Namespace
    • Elentra ACL
    • Authentication Methods
    • Compatibility Matrix
    • Elentra ME Versions
    • Elentra Settings
    • Elentra Deployment
    • Elentra API
    • Elentra JS
    • Feature Configuration
      • Event Resource Integration
      • Microsoft Teams Integration
    • Troubleshooting & Guides
      • New developer features in Elentra ME 1.22
      • Testing With Codeception
        • Unit Testing
          • Unit Testing Best Practises
          • Writing Unit Testable Code
          • PHPUnit Testing for API
          • PHPUnit Json String Compare Function
        • Functional Testing
          • Functional Testing Best Practices
        • Integration Testing
          • Integration Testing Best Practices
      • Upgrading elentra-developer Docker
      • VS Code Setup
      • Using XDebug in VSCode
      • Upgrading PHP
      • Switching Databases
      • Creating a new virtual host
      • Logging In
      • Composer
      • Curriculum Tag Selector
      • Performance Issues
      • Docker
      • Seed Data Generation
      • Fail Fast Programming
      • Advanced Custom Exception Classes
    • Support
  • Upgrade Guides
    • Upgrading to ME v28.0
    • Upgrading to ME 1.27
    • Upgrading to ME 1.26
    • Upgrading to ME 1.25
    • Upgrading to ME 1.24
    • Upgrading to ME 1.23
    • Upgrading to ME 1.22
    • Upgrading to ME 1.21
    • Upgrading to ME 1.20
    • Upgrading to ME 1.19
    • Upgrading to ME 1.18
    • Upgrading to ME 1.17
    • Upgrading to ME 1.16
    • Upgrading to ME 1.15
Powered by GitBook
On this page
  • Symlinking the API
  • Composer Install Errors
  • Composer Memory Error
  1. Developers
  2. Troubleshooting & Guides

Composer

Symlinking the API

Problem: changes made to API code are not reflected in requests, or running composer update yields a message stating that there is nothing to do.

  • Verify that you have cloned the API to your ~/Sites directory.

  • Verify that you are running the command composer update elentrapackages/elentra-1x-api after you have run composer install.

  • Verify that you have a composer-api-dev.json file in the root of your elentra-1x-me project.

  • Verify the following in your composer-api-dev.json file:

    • That the value for [BRANCH_NAME] matches the name of the branch that you currently have checked out in the API.

    • That the value for url points to the correct path that you cloned the API into.

{
  "repositories": [
      {
          "type": "path",
          "url": "../elentra-1x-api",
          "options": {
              "symlink": true
          }
      }
  ],
  "require": {
      "elentrapackages/elentra-1x-api": "dev-[BRANCH_NAME]"
  }
}

Composer Install Errors

You experience a either a 404 or 403 error when attempting to run composer install.

  • Ensure that you have set your composer auth token by running

    composer config --global --auth http-basic.repo.packagist.com token [YOUR_ORGANIZATION_TOKEN]
  • Ensure that you that you are using the private Packagist token provided to your organization by the Elentra Consortium.

Composer Memory Error

PHP fatal error: Allowed memory size of .... exhausted

Sometimes you may experience the error displayed here when attempting to run a composer install or composer update elentrapackages/elentra-1x-api . You can easily solve this problem by setting the memory limit to -1 before your composer command. Example:

// This is an example, and it works on other composer commands all the same
COMPOSER_MEMORY_LIMIT=-1 composer update elentrapackages/elentra-1x-api
PreviousLogging InNextCurriculum Tag Selector

Last updated 3 years ago