socialweb/atproto-lexicon

A PHP-based Lexicon parser for applications using the AT Protocol

0.2.1 2023-05-25 01:35 UTC

Requires

• php: ^8.2

Requires (Dev)

• ramsey/devtools: ^2.0
• symfony/finder: ^6.2

LGPL-3.0-or-later

• Lexicon
• atp
• bluesky
• atprotocol
• at-protocol

README

A PHP-based Lexicon parser for applications using the AT Protocol

About

socialweb/atproto-lexicon parses Lexicon schemas for the AT Protocol.

The current version is compliant with @atproto/lexicon at commit-ish a900e95.

This project adheres to a code of conduct. By participating in this project and its community, you are expected to uphold this code.

Installation

Install this package as a dependency using Composer.

composer require socialweb/atproto-lexicon

Usage

use SocialWeb\Atproto\Lexicon\Nsid\Nsid;
use SocialWeb\Atproto\Lexicon\Parser\DefaultParserFactory;
use SocialWeb\Atproto\Lexicon\Parser\DefaultSchemaRepository;
use SocialWeb\Atproto\Lexicon\Parser\LexiconParser;

$schemas = '/path/to/bluesky-social/lexicons';

$schemaRepository = new DefaultSchemaRepository($schemas);
$parser = new LexiconParser(new DefaultParserFactory($schemaRepository));

$nsid = new Nsid('app.bsky.feed.post');
$schemaFile = $schemaRepository->findSchemaPathByNsid($nsid);
$schemaContents = file_get_contents((string) $schemaFile);

$document = $parser->parse((string) $schemaContents);

Resolving References

Using this library, you may resolve references in Lexicon schemas.

For example:

use SocialWeb\Atproto\Lexicon\Types\LexResolvable;

foreach ($document->defs as $defId => $def) {
    if ($def instanceof LexResolvable) {
        $resolved = $def->resolve();
    }
}

Contributing

Contributions are welcome! To contribute, please familiarize yourself with CONTRIBUTING.md.

Coordinated Disclosure

Keeping user information safe and secure is a top priority, and we welcome the contribution of external security researchers. If you believe you've found a security issue in software that is maintained in this repository, please read SECURITY.md for instructions on submitting a vulnerability report.

Copyright and License

Copyright © the socialweb/atproto-lexicon Contributors and licensed for use under the terms of the GNU Lesser General Public License (LGPL-3.0-or-later) as published by the Free Software Foundation. Please see COPYING.LESSER, COPYING, and NOTICE for more information.