包简介

SchemaBuilder

README 文档

README

A simple library to generate Schema.org.

Quality

Installation

This library requires PHP 5.4 or later.

It is recommended that you install this library using Composer.

Dependencies

SchemaBuilder relies upon and requires the following dependencies:

danielstjules/stringy - A PHP string manipulation library.

Getting Started

Build Schema.org Object

Start by instantiating your primary Schema.org object with the type of the object.

For example, to create a Book:

<?php
$book = new NYPL\SchemaBuilder\Schema('Book');

Then, set the properties of the object wih the property name and value:

<?php
$book->addProperty('name', 'Le concerto');
$book->addProperty('author', 'Ferchault, Guy');

The property can also contain other Schema.org objects:

<?php
// First, build the Offer object
$offer = new Schema('Offer');
$offer->addProperty('availability', 'http://schema.org/InStock');
$offer->addProperty('serialNumber', 'CONC91000937');
// Then, set the "offers" property on the Book object with the Offer object
$book->addProperty('offers', $offer);

Output Schema.org as JSON-LD

When you have finished building your Schema.org object, output it in JSON-LD:

<head>
...
<?php $book->outputJsonLd();

Output Schema.org as Microdata

When you have finished building your Schema.org object, you can output it in two ways:

1. Properties Only

To output without a HTML wrapper use the outputMicrodata method with or without a property name.

// Output an Object
<div <?php $book->outputMicrodata(); ?> itemid="#record">
// Output an Object's property
<h1 <?php $book->outputMicrodata('name'); ?>><?php $book->outputProperty('name'); ?></h1>

If you do not specify a property name, microdata to describe the primary object will be generated.

Outputs:

<div itemscope itemtype="http://schema.org/Book" itemid="#record">
<h1 itemprop="name">Le concerto</h1>

2. Wrapped Properties

To output with a property with a HTML wrapper specify the name of the property and the wrapper that you want to use:

<?php $book->outputMicrodata('additionalType', 'link'); ?>
<?php $book->outputMicrodata('name', 'h3'); ?>

Outputs:

<link itemprop="additionalType" href="http://schema.org/Product">
<h3 itemprop="name">Le concerto</h3>

Tests

From the project directory, tests can be ran using phpunit.

nypl/schemabuilder 适用场景与选型建议

nypl/schemabuilder 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 26 次下载、GitHub Stars 达 3，最近一次更新时间为 2016 年 06 月 09 日，在 PHP 生态内属于活跃度较高的组件。

我们在过去多个企业项目中使用过 nypl/schemabuilder 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 nypl/schemabuilder 我们能提供哪些服务？

定制开发 / 二次开发

基于 nypl/schemabuilder 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

nypl/schemabuilder

包简介