PHP code example of exelearning / elp-parser
1. Go to this page and download the library: Download exelearning/elp-parser library . Choose the download type require .
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
exelearning / elp-parser example snippets
$stream = fopen($_FILES['project']['tmp_name'], 'rb');
$parser = ELPParser::fromStream($stream, 'elpx');
$parserFromBytes = ELPParser::fromContents($bytes, 'elpx');
if (ELPParser::supports($path)) {
echo ELPParser::identify($path); // legacy-v2, elpx-v4, ...
$info = ELPParser::probe($path); // alias of lightweight inspect()
}
use Exelearning\Archive\ArchiveLimits;
use Exelearning\ParserOptions;
$options = new ParserOptions(
archiveLimits: new ArchiveLimits(maxXmlBytes: 32 * 1024 * 1024),
parseAssets: false,
collectStrings: false,
normalizeIdeviceState: false
);
$parser = ELPParser::fromFile($path, $options);
$info = ELPParser::inspect('/path/to/project.elpx');
echo $info['title'];
echo $info['formatVersion'];
echo $info['packageProfile'];
use Exelearning\ELPParser;
$parser = ELPParser::fromFile('/path/to/project.elpx');
echo $parser->getTitle();
echo $parser->getVersion();
foreach ($parser->getStrings() as $string) {
echo $string . "\n";
}
echo $parser->getSourceExtension(); // elp | elpx
echo $parser->getContentFormat(); // legacy-contentv3 | ode-content
echo $parser->getContentFile(); // contentv3.xml | content.xml
echo $parser->getContentSchemaVersion(); // 2.0 for modern ODE packages
echo $parser->getFormatFamily(); // legacy | ode
echo $parser->getFormatVersion(); // null | 2.0
echo $parser->getExeVersion(); // raw upstream version string when present
echo $parser->getApplicationVersion(); // alias with explicit application semantics
echo $parser->getPackageProfile(); // legacy-v2 | elpx-v3 | elpx-v4 | ode-v3 ...
echo $parser->getResourceLayout(); // none | content-resources | legacy-temp-paths | mixed
echo $parser->getResourceProfile(); // v3-uuid-resources | v4-resource-tree | mixed-modern-resources | ...
$versionInfo = $parser->getVersionInfo();
// declared, declaredMajor, detectedMajor, source, signals
$pages = $parser->getPages();
$visiblePages = $parser->getVisiblePages();
$blocks = $parser->getBlocks();
$idevices = $parser->getIdevices();
// Modern iDevices expose storagePattern, data and stateDecodeError.
$pageTexts = $parser->getPageTexts();
$assets = $parser->getAssets();
$assetsDetailed = $parser->getAssetsDetailed();
$orphanAssets = $parser->getOrphanAssets();
$missingAssets = $parser->getMissingAssets();
$brokenReferences = $parser->getBrokenReferences();
$internalLinks = $parser->getInternalLinks();
$brokenInternalLinks = $parser->getBrokenInternalLinks();
$manifest = $parser->getPackageManifest();
$metadata = $parser->getMetadata();
$userPreferences = $parser->getUserPreferences();
$odeResources = $parser->getOdeResources();
$odeProperties = $parser->getOdeProperties();
$pageTree = $parser->getPageTree();
$result = $parser->validateResult();
if (!$result->isValid()) {
foreach ($result->errors() as $diagnostic) {
echo $diagnostic->getCode() . ': '
. $diagnostic->getMessage() . PHP_EOL;
}
}
use Exelearning\Parser\IdeviceDecoderInterface;
use Exelearning\Parser\IdeviceDecoderRegistry;
use Exelearning\ParserOptions;
$registry = new IdeviceDecoderRegistry([
new MyIdeviceDecoder(),
]);
$options = new ParserOptions(ideviceDecoders: $registry);
$parser = ELPParser::fromFile($path, $options);
$result = $parser->validate();
if (!$result['valid']) {
print_r($result['errors']);
}
print_r($result['warnings']);
use Exelearning\Validation\SchemaValidator;
$xsdResult = $parser->validateSchema('/trusted/path/ode-content.xsd');
$dtdResult = $parser->validateSchema(
'/trusted/path/content.dtd',
SchemaValidator::TYPE_DTD
);
use Exelearning\Archive\ArchiveLimits;
use Exelearning\ELPParser;
$limits = new ArchiveLimits(
maxEntries: 30000,
maxEntryBytes: 1073741824,
maxTotalBytes: 2147483647,
maxXmlBytes: 134217728,
maxCompressionRatio: 1000.0
);
$parser = ELPParser::fromFile('/path/to/project.elpx', $limits);
$archiveHash = $parser->getArchiveFingerprint();
$contentHash = $parser->getContentFingerprint();
$same = $parser->hasSameContentAs($otherParser);
$diff = $parser->diff($otherParser);
echo ELPParser::getDetailedSchemaVersion(); // 1.0
$schema = ELPParser::getDetailedJsonSchema();
$schemaPath = ELPParser::getDetailedJsonSchemaPath();
$json = $parser->exportJson();
$parser->exportJson('/path/to/output.json');
$detailedJson = $parser->exportDetailedJson();
$detailed = $parser->toDetailedArray();
if ($parser->hasEntry('content/resources/video.mp4')) {
$output = fopen('/tmp/video.mp4', 'wb');
try {
$parser->copyEntryToStream(
'content/resources/video.mp4',
$output
);
} finally {
fclose($output);
}
}
$smallFile = $parser->getEntryContents(
'content/resources/config.json',
1024 * 1024
);
$parser->extractEntry(
'content/resources/image.png',
'/tmp/image.png'
);
$parser->extract('/path/to/destination');
use Exelearning\ELPParser;
use Exelearning\Exception\ElpParserException;
try {
$parser = ELPParser::fromFile('/path/to/project.elpx');
} catch (ElpParserException $exception) {
echo $exception->getMessage();
}
bash
php tests/upstream-compat.php /path/to/exelearning/test/fixtures