app.php

<?php
/*
 * Copyright (C) Maarch
 *
 * This file is part of Maarch RM.
 *
 * Maarch RM is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Maarch RM is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Maarch RM. If not, see <http://www.gnu.org/licenses/>.
 */
// The Maarch http application will be used`with JsonApi documents for the schema
use Maarch\Http\Application;
use Maarch\JsonApi\Schema as JsonApi;
use Maarch\Metamodel;

// DOC
$docTemplate = new Metamodel\Documentation();

// DEFINITIONS -> SCHEMA
$schema = new Application\Schema();

$typeTemplate = new Metamodel\Type();
$propertyTemplate = new JsonApi\Property();
$linkTemplate = new Application\Link();
$paramTemplate = new Application\Parameter();

$attributesPropertyTemplate = $propertyTemplate->withName('attributes');
$relationshipsPropertyTemplate = $propertyTemplate->withName('relationships');
$metadataPropertyTemplate = $propertyTemplate->withName('metadata');
$objectTemplate = $typeTemplate->withType('object');
$resourceTemplate = new JsonApi\Resource();
$ressourceCollectionTemplate = new JsonApi\ResourceCollection();

// The configuration is included from a directory contents
// This path MUST be set by an external configuration (ini, constant...)
$schemaConfDir = __DIR__.'/schema';
$schemaConf = [];
foreach (scandir($schemaConfDir) as $schemaConfFile) {
    if (is_file($schemaConfDir.DIRECTORY_SEPARATOR.$schemaConfFile)) {
        $types = include($schemaConfDir.DIRECTORY_SEPARATOR.$schemaConfFile);

        foreach ($types as $name => $type) {
            $schema->set($name, $type);
        }
    }
}


// DEFINITIONS -> REPRESENTATIONS
$representations = new Application\Definitions();
$representationTemplate = new Application\Representation(['mediaType' => 'application/vnd.api+json']);

$representations->set('orgCollectionRepresentation', $representationTemplate->withType('orgs'));
$representations->set('orgRepresentation', $representationTemplate->withType('org'));

$representations->set('orgUnitCollectionRepresentation', $representationTemplate->withType('orgUnits'));
$representations->set('orgUnitRepresentation', $representationTemplate->withType('orgUnit'));

$representations->set('folderCollectionRepresentation', $representationTemplate->withType('folders'));
$representations->set('folderRepresentation', $representationTemplate->withType('folder'));

$representations->set('archiveUnitCollectionRepresentation', $representationTemplate->withType('archiveUnits'));
$representations->set('archiveUnitRepresentation', $representationTemplate->withType('archiveUnit'));
$representations->set('archiveUnitDescriptionRepresentation', $representationTemplate->withType('archiveUnitDescription'));
$representations->set('archiveUnitManagementRepresentation', $representationTemplate->withType('archiveUnitManagement'));

$representations->set('dataObjectCollectionRepresentation', $representationTemplate->withType('dataObjects'));
$representations->set('dataObjectRepresentation', $representationTemplate->withType('dataObject'));

$representations->set('archiveUnitProfileCollectionRepresentation', $representationTemplate->withType('archiveUnitProfiles'));
$representations->set('archiveUnitProfileRepresentation', $representationTemplate->withType('archiveUnitProfile'));

// RESPONSES
$responses = new Application\Definitions();
$responseTemplate = new Application\Response();

$responses->set('getOrgsResponse', $responseTemplate->withRepresentation('jsonapi', 'orgCollectionRepresentation'));
$responses->set('getOrgResponse', $responseTemplate->withRepresentation('jsonapi', 'orgRepresentation'));

$responses->set('getOrgUnitsResponse', $responseTemplate->withRepresentation('jsonapi', 'orgUnitCollectionRepresentation'));
$responses->set('getOrgUnitResponse', $responseTemplate->withRepresentation('jsonapi', 'orgUnitRepresentation'));

$responses->set('getFoldersResponse', $responseTemplate->withRepresentation('jsonapi', 'folderCollectionRepresentation'));
$responses->set('getFolderResponse', $responseTemplate->withRepresentation('jsonapi', 'folderRepresentation'));

$responses->set('getArchiveUnitsResponse', $responseTemplate->withRepresentation('jsonapi', 'archiveUnitCollectionRepresentation'));
$responses->set('getArchiveUnitResponse', $responseTemplate->withRepresentation('jsonapi', 'archiveUnitRepresentation'));
$responses->set('getArchiveUnitDescriptionResponse', $responseTemplate->withRepresentation('jsonapi', 'archiveUnitDescriptionRepresentation'));
$responses->set('getArchiveUnitManagementResponse', $responseTemplate->withRepresentation('jsonapi', 'archiveUnitManagementRepresentation'));

$responses->set('getDataObjectsResponse', $responseTemplate->withRepresentation('jsonapi', 'dataObjectCollectionRepresentation'));
$responses->set('getDataObjectResponse', $responseTemplate->withRepresentation('jsonapi', 'dataObjectRepresentation'));

$responses->set('getArchiveUnitProfilesResponse', $responseTemplate->withRepresentation('jsonapi', 'archiveUnitProfileCollectionRepresentation'));
$responses->set('getArchiveUnitProfileResponse', $responseTemplate->withRepresentation('jsonapi', 'archiveUnitProfileRepresentation'));

// OPERATIONS
$operations = new Application\Definitions();
$operationTemplate = new Application\Operation();

$operations->set('getResourceDescriptionOperation', $operationTemplate->withEndpoint('getResourceDescription'));
$operations->set('getAppDescriptionOperation', $operationTemplate->withEndpoint('getAppDescription'));

// Orgs
$operations->set('getOrgsOperation', $operationTemplate->withEndpoint('getOrgs')->withResponse('default', 'getOrgsResponse'));
$operations->set('getOrgOperation', $operationTemplate->withEndpoint('getOrg')->withResponse('default', 'getOrgResponse'));
$operations->set('getOrgOrgUnitsOperation', $operationTemplate->withEndpoint('getOrgOrgUnits')->withResponse('default', 'getOrgUnitsResponse'));
$operations->set('getOrgParentOperation', $operationTemplate->withEndpoint('getOrgParent')->withResponse('default', 'getOrgResponse'));
$operations->set('getOrgChildrenOperation', $operationTemplate->withEndpoint('getOrgChildren')->withResponse('default', 'getOrgsResponse'));

// OrgUnits
$operations->set('getOrgUnitsOperation', $operationTemplate->withEndpoint('getOrgUnits')->withResponse('default', 'getOrgUnitsResponse'));
$operations->set('getOrgUnitOperation', $operationTemplate->withEndpoint('getOrgUnit')->withResponse('default', 'getOrgUnitResponse'));
$operations->set('getOrgUnitParentOperation', $operationTemplate->withEndpoint('getOrgUnitParent')->withResponse('default', 'getOrgUnitResponse'));
$operations->set('getOrgUnitChildrenOperation', $operationTemplate->withEndpoint('getOrgUnitChildren')->withResponse('default', 'getOrgUnitsResponse'));
$operations->set('getOrgUnitFoldersOperation', $operationTemplate->withEndpoint('getOrgUnitFolders')->withResponse('default', 'getFoldersResponse'));
$operations->set('getOrgUnitArchiveUnitsOperation', $operationTemplate->withEndpoint('getOrgUnitArchiveUnits')->withResponse('default', 'getArchiveUnitsResponse'));

// Folders
$operations->set('getFoldersOperation', $operationTemplate->withEndpoint('getFolders')->withResponse('default', 'getFoldersResponse'));
$operations->set('getFolderOperation', $operationTemplate->withEndpoint('getFolder')->withResponse('default', 'getFolderResponse'));
$operations->set('getFolderParentOperation', $operationTemplate->withEndpoint('getFolderParent')->withResponse('default', 'getFolderResponse'));
$operations->set('getFolderChildrenOperation', $operationTemplate->withEndpoint('getFolderChildren')->withResponse('default', 'getFoldersResponse'));
$operations->set('getFolderArchiveUnitsOperation', $operationTemplate->withEndpoint('getFolderArchiveUnits')->withResponse('default', 'getArchiveUnitsResponse'));

$operations->set('createFolderOperation', $operationTemplate->withEndpoint('createFolder')->withResponse('default', 'getFolderResponse'));

// ArchiveUnits
$operations->set('getArchiveUnitsOperation', $operationTemplate->withEndpoint('getArchiveUnits')->withResponse('default', 'getArchiveUnitsResponse'));
$operations->set('getArchiveUnitOperation', $operationTemplate->withEndpoint('getArchiveUnit')->withResponse('default', 'getArchiveUnitResponse'));
$operations->set('getArchiveUnitDescriptionOperation', $operationTemplate->withEndpoint('getArchiveUnitDescription')->withResponse('default', 'getArchiveUnitDescriptionResponse'));
$operations->set('getArchiveUnitManagementOperation', $operationTemplate->withEndpoint('getArchiveUnitManagement')->withResponse('default', 'getArchiveUnitManagementResponse'));
$operations->set('getArchiveUnitChildrenOperation', $operationTemplate->withEndpoint('getArchiveUnitChildren')->withResponse('default', 'getArchiveUnitsResponse'));
$operations->set('getArchiveUnitParentOperation', $operationTemplate->withEndpoint('getArchiveUnitParent')->withResponse('default', 'getArchiveUnitResponse'));

$operations->set('getArchiveUnitDataObjectsOperation', $operationTemplate->withEndpoint('getArchiveUnitDataObjects')->withResponse('default', 'getDataObjectsResponse'));
$operations->set('getArchiveUnitDataObjectOperation', $operationTemplate->withEndpoint('getArchiveUnitDataObject')->withResponse('default', 'getDataObjectResponse'));
$operations->set('getArchiveUnitDataObjectContentsOperation', $operationTemplate->withEndpoint('getArchiveUnitDataObjectContents')->withResponse('default', 'getDataObjectContentsResponse'));

// DataObjects
$operations->set('getDataObjectsOperation', $operationTemplate->withEndpoint('getDataObjects')->withResponse('default', 'getDataObjectsResponse'));
$operations->set('getDataObjectOperation', $operationTemplate->withEndpoint('getDataObject')->withResponse('default', 'getDataObjectResponse'));
$operations->set('getDataObjectContentsOperation', $operationTemplate->withEndpoint('getDataObjectContents')->withResponse('default', 'getDataObjectContentsResponse'));

// ArchiveUnitProfiles
$operations->set('getArchiveUnitProfilesOperation', $operationTemplate->withEndpoint('getArchiveUnitProfiles')->withResponse('default', 'getArchiveUnitProfilesResponse'));
$operations->set('getArchiveUnitProfileOperation', $operationTemplate->withEndpoint('getArchiveUnitProfile')->withResponse('default', 'getArchiveUnitProfileResponse'));
$operations->set('getArchiveUnitDescriptionProfileOperation', $operationTemplate->withEndpoint('getArchiveUnitDescriptionProfile')->withResponse('default', 'getArchiveUnitDescriptionProfileResponse'));

// PATHS -> RESOURCES

$resourceIdParamTemplate = new Application\Parameter(['binding' => 'path', 'type' => $typeTemplate->withType('string'), 'isRequired' => true]);
$resourceTemplate = new Application\Resource();

// App
$appResource = $resourceTemplate
    ->withOperation('get', 'getAppDescriptionOperation');

// docs
$typeParam = $resourceIdParamTemplate
    ->withName('type')
    ->withType(
        $typeTemplate
            ->withType('string')
            ->withEnum(['orgs', 'orgUnits', 'folders', 'archiveUnits', 'archiveProfileUnits'])
    )
    ->withDocumentation(
        $docTemplate
            ->withSummary('resourceType')
    )
;
$resourceDescriptionResource = $resourceTemplate
    ->withParameters([$typeParam])
    ->withOperation('get', 'getResourceDescriptionOperation');

// Orgs
$orgIdParam = $resourceIdParamTemplate->withName('orgId');
$orgResource = $resourceTemplate
    ->withParameters([$orgIdParam])
    ->withOperation('get', 'getOrgOperation')
    ->withResource(
        'parent',
        $resourceTemplate
            ->withParameters([$orgIdParam])
            ->withOperation('get', 'getOrgParentOperation')
    )
    ->withResource(
        'children',
        $resourceTemplate
            ->withParameters([$orgIdParam])
            ->withOperation('get', 'getOrgChildrenOperation')
    )
    ->withResource(
        'orgUnits',
        $resourceTemplate
            ->withParameters([$orgIdParam])
            ->withOperation('get', 'getOrgOrgUnitsOperation')
    )
;
$orgCollectionResource = $resourceTemplate
    ->withOperation('get', 'getOrgsOperation')
    ->withResource('{orgId}', $orgResource);

// OrgUnits
$orgUnitIdParam = $resourceIdParamTemplate->withName('orgUnitId');
$orgUnitResource = $resourceTemplate
    ->withParameters([$orgUnitIdParam])
    ->withOperation('get', 'getOrgUnitOperation')
    ->withResource(
        'parent',
        $resourceTemplate
            ->withParameters([$orgUnitIdParam])
            ->withOperation('get', 'getOrgUnitParentOperation')
    )
    ->withResource(
        'children',
        $resourceTemplate
            ->withParameters([$orgUnitIdParam])
            ->withOperation('get', 'getOrgUnitChildrenOperation')
    )
    ->withResource(
        'folders',
        $resourceTemplate
            ->withParameters([$orgUnitIdParam])
            ->withOperation('get', 'getOrgUnitFoldersOperation')
    )
    ->withResource(
        'archiveUnits',
        $resourceTemplate
            ->withParameters([$orgUnitIdParam])
            ->withOperation('get', 'getOrgUnitArchiveUnitsOperation')
    )
;
$orgUnitCollectionResource = $resourceTemplate
    ->withOperation('get', 'getOrgUnitsOperation')
    ->withResource('{orgUnitId}', $orgUnitResource)
;


// Folders
$folderIdParam = $resourceIdParamTemplate->withName('folderId');
$folderResource = $resourceTemplate
    ->withParameters([$folderIdParam])
    ->withOperation('get', 'getFolderOperation')
    ->withResource(
        'parent',
        $resourceTemplate
            ->withParameters([$folderIdParam])
            ->withOperation('get', 'getFolderParentOperation')
    )
    ->withResource(
        'children',
        $resourceTemplate
            ->withParameters([$folderIdParam])
            ->withOperation('get', 'getFolderChildrenOperation')
    )
    ->withResource(
        'archiveUnits',
        $resourceTemplate
            ->withParameters([$folderIdParam])
            ->withOperation('get', 'getFolderArchiveUnitsOperation')
    )
;
$folderCollectionResource = $resourceTemplate
    ->withOperation('get', 'getFoldersOperation')
    ->withResource('{folderId}', $folderResource)
;

// ArchiveUnits and DataObjects
$archiveUnitIdParam = $resourceIdParamTemplate->withName('archiveUnitId');
$dataObjectIdParam = $resourceIdParamTemplate->withName('dataObjectId');
$archiveUnitResource = $resourceTemplate
    ->withParameters([$archiveUnitIdParam])
    ->withOperation('get', 'getArchiveUnitOperation')
    ->withResource(
        'description',
        $resourceTemplate
            ->withParameters([$archiveUnitIdParam])
            ->withOperation('get', 'getArchiveUnitDescriptionOperation')
    )
    ->withResource(
        'management',
        $resourceTemplate
            ->withParameters([$archiveUnitIdParam])
            ->withOperation('get', 'getArchiveUnitManagementOperation')
    )
    ->withResource(
        'parent',
        $resourceTemplate
            ->withParameters([$archiveUnitIdParam])
            ->withOperation('get', 'getArchiveUnitParentOperation')
    )
    ->withResource(
        'children',
        $resourceTemplate
            ->withParameters([$archiveUnitIdParam])
            ->withOperation('get', 'getArchiveUnitChildrenOperation')
    )
    ->withResource(
        'dataObjects',
        $resourceTemplate
            ->withParameters([$archiveUnitIdParam])
            ->withOperation('get', 'getArchiveUnitDataObjectsOperation')
            ->withResource(
                '{dataObjectId}',
                $resourceTemplate
                    ->withParameters([$archiveUnitIdParam, $dataObjectIdParam])
                    ->withOperation('get', 'getArchiveUnitDataObjectOperation')
                    ->withResource(
                        'contents',
                        $resourceTemplate
                            ->withParameters([$archiveUnitIdParam, $dataObjectIdParam])
                            ->withOperation('get', 'getArchiveUnitDataObjectContentsOperation')
                    )
            )
    )
;
$archiveUnitCollectionResource = $resourceTemplate
    ->withOperation('get', 'getArchiveUnitsOperation')
    ->withResource('{archiveUnitId}', $archiveUnitResource)
;

// ArchiveUnitProfiles
$archiveUnitProfileIdParam = $resourceIdParamTemplate->withName('archiveUnitProfileId');
$archiveUnitProfileResource = $resourceTemplate
    ->withParameters([$archiveUnitProfileIdParam])
    ->withOperation('get', 'getArchiveUnitProfileOperation')
    ->withResource(
        'descriptionProfile',
        $resourceTemplate
            ->withParameters([$archiveUnitProfileIdParam])
            ->withOperation('get', 'getArchiveUnitDescriptionProfileOperation')
    )
;
$archiveUnitProfileCollectionResource = $resourceTemplate
    ->withOperation('get', 'getArchiveUnitProfilesOperation')
    ->withResource('{archiveUnitProfileId}', $archiveUnitProfileResource);


// APP
$app = new Application\Application();
$app = $app
    ->withHost('http://maarchrm')
    ->withBasePath('/V3')
// REFS -> TYPES
    ->withDefinition('schema', $schema)
    ->withDefinition('representations', $representations)
    ->withDefinition('responses', $responses)
    ->withDefinition('operations', $operations)

// PATHS -> RESOURCES
    ->withResource('', $appResource)
    ->withResource('docs/types/{type}', $resourceDescriptionResource)
    ->withResource('orgs', $orgCollectionResource)
    ->withResource('orgUnits', $orgUnitCollectionResource)
    ->withResource('folders', $folderCollectionResource)
    ->withResource('archiveUnits', $archiveUnitCollectionResource)
    ->withResource('archiveUnitProfiles', $archiveUnitProfileCollectionResource)
;


// The Json for OpenApi configuration
// This path MUST be set by an external configuration (ini, constant...)
/*$appConfFile = 'V3/App/conf/openapi.json';
$openApi = json_decode(file_get_contents($appConfFile));

// The app endpoint
// This url MUST be set by an external configuration (ini, constant...)
$openApi->host = 'http://maarchrm';

// Instanciate the Maarch http application
$app = new App($openApi);

//$container->add('App', $app);*/

$container->add('App', $app);

// Return the Maarch http application to the caller
return $app;