README

需求

CakePHP 2.x

安装

在Packagist上查看，并将最新版本的json片段复制到您的项目的composer.json文件中。例如，v. 1.0.0将看起来像这样

{
    "require": {
        "josegonzalez/cakephp-sham": "1.0.0"
    }
}

因为此插件在其自己的composer.json中设置了类型cakephp-plugin，所以composer知道将其安装在您的/Plugins目录中，而不是在常规的vendor文件中。建议您将/Plugins/Sham添加到您的.gitignore文件中。（为什么？阅读此内容。）

[手动]

下载此内容： https://github.com/josegonzalez/cakephp-sham/zipball/master
解压下载内容。
将生成的文件夹复制到app/Plugin
将您刚刚复制的文件夹重命名为Sham

[GIT 子模块]

在您的app目录中输入

git submodule add git://github.com/josegonzalez/cakephp-sham.git Plugin/Sham
git submodule init
git submodule update

[GIT Clone]

在您的插件目录中输入

git clone git://github.com/josegonzalez/cakephp-sham.git Sham

启用插件

在使用之前，您必须启用此插件

CakePlugin::load('Sham');

如果您在使用前已经使用过CakePlugin::loadAll();，则此步骤不是必需的。

使用

将组件和帮助器添加到您的AppController的$components和$helpers数组中

<?php
class AppController extends Controller {
    public $components = array('Sham.Sham');
    public $helpers = array('Sham.Sham');
}
?>

默认情况下，Sham不会自动从数据库中加载SEO数据。您应该在控制器中创建回调来执行此操作。回调基于每个操作，以_seo开头，其中操作的第一个字母是大写

<?php
class UsersController extends AppController {

    public function profile($username = null) {
        // Some code that works with user profiles
    }

    public function _seoProfile() {
        // Called in the beforeRender() if the action was successfully processed
        $user = $this->viewVars['user'];
        $this->Sham->loadBySlug('view/' . $user['User']['username']);

        // Set some defaults in case the record could not be loaded from the DB
        $description = "awesome description of the page, with some good default keywords, referencing {$user['User']['username']}";
        $keywords = array($user['User']['username'] . ' profile', 'profiles', 'social network');

        $this->Sham->setMeta('title', "{$user['User']['username']}'s Profile  | Social Network");
        $this->Sham->setMeta('description', $description);
        $this->Sham->setMeta('keywords', implode(', ', $keywords));
        $this->Sham->setMeta('canonical', "/view/{$user['User']['username']}/", array('escape' => false));
    }
}
?>

如果您没有特定操作的回调，始终可以选择指定“回退”方法。这可以在组件设置中配置，但默认为Controller::_seoFallback()

<?php
class AppController extends Controller {
    public $components = array('Sham.Sham');
    public $helpers = array('Sham.Sham');

    public function _seoFallback() {
        // ... code ...
    }
}
?>

加载SEO数据后，就是为视图设置它的时候了。包含一个ShamHelper，它将自动处理这些细节

<!DOCTYPE html>
<html lang="en">
    <head>
        <?php echo $this->Sham->out('charset'); ?>
        <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
        <?php echo $this->Sham->out(null, array('skip' => array('charset'))); ?>
        <?php echo $this->Html->css(array('style', 'uniform.default')); ?>
    <head>
    <body>
        ...
    </body>
</html>

如您所见，在必要时我们可以调用单个SEO信息 - 在这种情况下是字符集 - 然后通过将null作为选项传递给帮助器来调用其余部分。在某些情况下，这可能非常有用，您可能需要以特定的顺序具有SEO数据。

待办事项

记录帮助器和组件选项

许可证

特此授予任何获得此软件及其相关文档文件（“软件”）副本的任何人无限制使用软件的权利，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本的权利，并允许向软件提供者提供软件的人这样做，但受以下条件约束

josegonzalez / cakephp-sham

维护者

详细信息

README

需求

安装

启用插件

使用

待办事项

许可证