eoidigital/eoi-blackboard-bundle

A Symfony2 Wrapper for the Blackboard's SOAP Web Service API

v1.0.0 2015-03-21 10:08 UTC

This package is not auto-updated.

Last update: 2022-08-06 05:49:22 UTC


README

A symfony2 bundle to communicate to Blackboard's API.

Installation

Step 1: Using Composer

Install it with Composer!

// composer.json
{
    // ...
    require: {
        // ...
        "eoidigital/eoi-blackboard-bundle": "dev-master",
    }
}

Then, you can install the new dependencies by running Composer's update command from the directory where your composer.json file is located:

$ php composer.phar update

Step 2: Register the bundle

Enable the bundle by adding the following line in the app/AppKernel.php file of your Symfony application:

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new EOI\BlackboardBundle\EOIBlackboardBundle(),
        );
    }

    // ...
}

Step 3: Configure the bundle

# app/config/config.yml
# You can get these parameters from your Blackboard Admin Panel > Building Blocks > Proxy Tools"
eoi_blackboard:
    proxy_tool:
        password: yourPassword
        clientVendorId: yourVendorId
        clientProgramId: yourProgramId
        loginExtraInfo: ~
        expectedLifeSeconds: 2

Step 4: Configure BeSimpleSoapClient

# app/config/config.yml
# You can get these parameters from your Blackboard Admin Panel > Building Blocks > Web Services"
be_simple_soap:
    clients:
        ContextApi:
            wsdl: https://your.blackboard.domain/webapps/ws/services/Context.WS?wsdl
        UserApi:
            wsdl: https://your.blackboard.domain/webapps/ws/services/User.WS?wsdl
            classmap:
                UserVO: EOI\BlackboardBundle\VO\UserVO
                UserExtendedInfoVO: EOI\BlackboardBundle\VO\UserExtendedInfoVO
        CourseApi:
            wsdl: https://your.blackboard.domain/webapps/ws/services/Course.WS?wsdl
            classmap:
                CourseVO: EOI\BlackboardBundle\VO\CourseVO
        CourseMembershipApi:
            wsdl: https://https://your.blackboard.domain/webapps/ws/services/CourseMembership.WS?wsdl
            classmap:
                CourseVO: EOI\BlackboardBundle\VO\CourseMembershipVO

LEGAL DISCLAIMER

This software is published under the MIT License, which states that:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.