2017 © Pedro Peláez
 

library lib

The PHP Library to build interoperable learning tools

image

tsugi/lib

The PHP Library to build interoperable learning tools

  • Wednesday, August 1, 2018
  • by drchuck
  • Repository
  • 1 Watchers
  • 1 Stars
  • 504 Installations
  • PHP
  • 3 Dependents
  • 0 Suggesters
  • 12 Forks
  • 10 Open issues
  • 8 Versions
  • 4 % Grown

The README.md

Tsugi PHP Library

Apereo Incubating badge Build Status, (*1)

This is part of the Tsugi PHP Project and contains the run-time objects and scripts that support PHP Tsugi applications and modules., (*2)

Here is some documentation for the APIs that are provided by this library:, (*3)

In addition to being used as part of the base Tsugi installs, Tsugi standalone application or modules will generally pull this in as a Packagist dependency using Composer., (*4)

For samples of how to use this code in a standalone library or an application, please see the following repositories:, (*5)

  • Sample Tsugi Module - Copy this if you want to start a fresh Tsugi Module from scratch. If you are building a new tool from scratch, you should build it as a "Tsugi Module" following all of the Tsugi style guidance, using the Tsugi browser environment, and making full use of the Tsugi framework. This repository contains a basic "Tsugi Module" you can use as a starting point., (*6)

  • Sample Tsugi-Enabled Application - You can also use Tsugi as a library and add it to a few places in an existing application. This repository contains sample code showing how to use Tsugi as a library in an existing application., (*7)

Unit Testing

To download PHPUnit (and any other development dependencies):, (*8)

composer install

To test:, (*9)

./vendor/bin/phpunit tests --bootstrap vendor/autoload.php

To run one test:, (*10)

vendor/bin/phpunit --filter {EntryTest}

Pulling in to Tsugi

Edit composer.json and, (*11)

composer update --prefer-dist tsugi/lib

Releasing

This is stored in Packagist., (*12)

https://packagist.org/packages/tsugi/lib

Making PHPDoc

Read this:, (*13)

https://github.com/FriendsOfPHP/Sami

Curl this:, (*14)

curl -O http://get.sensiolabs.org/sami.phar

Run this:, (*15)

rm -r /tmp/tsugi/
php sami.phar update sami-config-dist.php
mv /tmp/tsugi/sami.js /tmp/tsugi/s.js
sed 's/".html"/"index.html"/' < /tmp/tsugi/s.js > /tmp/tsugi/sami.js
rm /tmp/tsugi/s.js
open /tmp/tsugi/index.html

The Versions

01/08 2018

dev-master

9999999-dev http://www.tsugi.org/

The PHP Library to build interoperable learning tools

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

22/04 2018

0.5.0

0.5.0.0 http://www.tsugi.org/

The PHP Library to build interoperable learning tools

  Sources   Download

Apache-2.0

The Requires

 

The Development Requires

14/02 2018

0.2.0.x-dev

0.2.0.9999999-dev http://www.tsugi.org/

The PHP Library to build interoperable learning tools

  Sources   Download

Apache-2.0 Apache 2.0

The Requires

  • php >=5.5.0

 

10/08 2017

0.4.2

0.4.2.0 http://www.tsugi.org/

The PHP Library to build interoperable learning tools

  Sources   Download

Apache-2.0

The Requires

 

04/06 2017

0.3.2

0.3.2.0 http://www.tsugi.org/

The PHP Library to build interoperable learning tools

  Sources   Download

Apache-2.0

The Requires

 

05/01 2017

0.3.1

0.3.1.0 http://www.tsugi.org/

The PHP Library to build interoperable learning tools

  Sources   Download

Apache-2.0

The Requires

  • php >=5.5.0

 

23/11 2016

0.3.0

0.3.0.0 http://www.tsugi.org/

The PHP Library to build interoperable learning tools

  Sources   Download

Apache-2.0

The Requires

  • php >=5.5.0

 

02/01 2016

0.0.1-alpha

0.0.1.0-alpha http://www.tsugi.org/

The PHP Library to build interoperabile learning tools

  Sources   Download

Apache 2.0

The Requires

  • php >=5.5.0