包简介

Schema.org yii2 representation and helpers for json-ld generation in Yii framework

README 文档

README

Schema.org yii2 representation and helpers for json-ld generation.

Resources

JSON-LD documentation
Google Structured Data Testing Tool

Installation

The preferred way to install this extension is through composer.

Either run

$ php composer.phar require --prefer-dist simialbi/yii2-schema-org

or add

"simialbi/yii2-schema-org": "^2.0.0"

to the require section of your composer.json

Usage

In order to use this module, you will need to:

Configure your application so that the module is available.
Generate the Schemas you intend to use.

Setup Module

Configure the module named schema in the modules section of your Yii configuration file.

Remember to do this for console and for web application configuration file.

'modules' => [
	'schema' => [
		'class' => 'simialbi\yii2\schemaorg\Module',
		//'autoCreate' => false,
		//'autoRender' => false
	]
]

Also add the module schema to the bootstrap section of your configuration file:

'bootstrap' => ['log', 'schema']

Parameter	Description
`autoCreate`	Automatically create breadcrumbs `json+ld` data.
`autoRender`	Automatically render `json+ld` data at the end of body section.
`mergeModels`	Merge models into one script tag instead of rendering one for each of them.

If you don't use autoRender, be sure to manually call JsonLDHelper::render() in your layout file, like so:

<?php
/* @var $this \yii\web\View */
/* @var $content string */
use yii\helpers\Html;
use app\assets\AppAsset;
use simialbi\yii2\schemaorg\helpers\JsonLDHelper;

AppAsset::register($this);
?>
<?php $this->beginPage() ?>
<!DOCTYPE html>
<html lang="<?= Yii::$app->language ?>">
<head>
    <meta charset="<?= Yii::$app->charset ?>">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <?= Html::csrfMetaTags() ?>
    <title><?= Html::encode($this->title) ?></title>
    <?php JsonLDHelper::render(); ?>
    <?php $this->head() ?>
</head>

Model generation

Minimal (standard) configuration

Without passing any parameters all schemas will be generated in the folder @vendor/simialbi/yii2-schema-org/src/models. The namespace of the models will be simialbi\yii2\schemaorg\models.

$ php yii schema/models/generate

Customized

If you want to customize the namespace and path you can do it via --namespace and --folder parameters. E.g. to generate schemas Car and AutoDealer in common/schemas with common\schemas namespace:

$ php yii schema/models/generate 'latest' --schemas=Car,AutoDealer --namespace='common\schemas' --folder='@common/schemas/'

Parameter	Description
`version`	The schemas.org version to use. Defaults to `latest`
`--schemas`	A comma separated list of schemas you intend to use. Empty means all. Defaults to `[]`
`--namespace`	The namespace to use for the generated classes and traits. Defaults to `simialbi\yii2\schemaorg\models`
`--folder`	The folder where to put the generated files. Defaults to `@simialbi/yii2/schemaorg/src/models`
`--remove-old`	Whether to remove old files before generating. Defaults to `false`

The console command will take care of computing schemas dependencies and will generate the classes based on your needs.

Automatic model update on composer update

If you'd like to always update your schema when you run composer update you can configure your composer.json like this:

{
  // [...]
  "require": {
    "yiisoft/yii2": "^2.0.13",
    "simialbi/yii2-schema-org": "^2.0.0"
  },
  "scripts": {
    "post-update-cmd": [
      "simialbi\\yii2\\schemaorg\\composer\\Installer::postInstallUpdate"
    ]
  },
  "extra": {
    "simialbi\\yii2\\schemaorg\\composer\\Installer::postInstallUpdate": {
      "generateModels": {
        "schemas": ["Car", "AutoDealer"], // optional
        "namespace": "common\\schemas", // optional
        "folder": "common/schema" // optional
      }
    }
  }
  // [...]
}

Example Usage

To e.g. add a person to json+ld, you can do the following:

use simialbi\yii2\schemaorg\helpers\JsonLDHelper;
use simialbi\yii2\schemaorg\models\Person;

$child = new Person();
$child->name = 'George W. Bush';
$child->disambiguatingDescription = '43rd President of the United States';
$person = new Person();
$person->name = 'George Bush';
$person->disambiguatingDescription = '41st President of the United States';
$person->children = [$child];

JsonLDHelper::add($person);

License

yii2-schema-org is released under MIT license. See bundled LICENSE for details.

simialbi/yii2-schema-org 适用场景与选型建议

simialbi/yii2-schema-org 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 106.75k 次下载、GitHub Stars 达 18，最近一次更新时间为 2017 年 08 月 11 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「JSON-LD」「jsonld」「microdata」「yii2」「structured-data」「schema-org」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

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

围绕 simialbi/yii2-schema-org 我们能提供哪些服务？

定制开发 / 二次开发

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

BUG 修复 & 性能优化

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

项目外包 & 长期维护

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

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

与 simialbi/yii2-schema-org 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

webnuvola/laravel-json-ld 5

Laravel wrapper for torann/json-ld

sweetrdf/json-ld 3

JSON-LD Processor for PHP

hypejunction/http-parser 5

A tool for scraping URL resources (oEmbed, OpenGraph, Twitter cards, JSON-LD)

turahe/seotools 0

SEO Tools for Laravel and Lumen

exs/schema-breadcrumb-bundle 0

This bundle generates microdata for breadcrumb.

k00ni/json-ld 3