serega3000/laravel-head

为Laravel自动定制和自动化布局的head部分

维护者

详情

github.com/serega3000/laravel-head

源代码

安装次数: 6

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 8

dev-master 2015-03-26 08:35 UTC

Requires

MIT cf910c50b17d56890eeb87f649fd13ec7455bffa

  • Gwen Nobots <gwen.woop@nobots.fr>

analyticsHTML5twitterfacebooklayoutscriptslaravelmetastylesheets

This package is not auto-updated.

Last update: 2024-09-14 16:51:19 UTC

README

此包自动化和简化了使用Laravel 4和5的HTML5布局中<head></head>部分的管理。它提供以下功能

  • 元标签。
  • 链接标签。
  • 样式表。
  • 脚本。
  • 字符集、favicon、标题和描述标签。
  • 搜索引擎。
  • 响应式设计。
  • Internet Explorer兼容性。
  • Facebook的Open Graph协议。
  • Twitter Card。
  • Google的通用分析。

安装

在composer.json中添加此包，并运行composer update

"gwnobots/laravel-head": "dev-master"

更新composer后，将ServiceProvider添加到app/config/app.php中的providers数组

'Gwnobots\LaravelHead\LaravelHeadServiceProvider',

您需要发布此包的配置

$ php artisan config:publish gwnobots/laravel-head

您不需要在app/config/app.php中添加别名，因为它已经在ServiceProvider中注册（参见Philip Brown和Chris Fidao的文章）。

用法

您可以在速查表中查看所有可用方法的摘要。

渲染

要显示<head></head>部分中的所有自定义标签，只需在布局中添加以下内容

<head>
	<?php echo Head::render(); ?>
</head>

// or with a blade layout
<head>
	{{ Head::render() }}
</head>

基本设置

在包的config.php中，您可以设置一些默认值，如字符集、网站名称、描述、favicon等（有关更多信息，请参阅config.php中的注释）。如果您在当前请求中没有使用特殊方法（在路由或控制器中）覆盖它们，则将使用这些设置

// define encoding for <meta charset=""> tag
Head::setCharset('charset');

// define a title for <title> tag
Head::setTitle('title');

// de|activate the addition of default sitename to title
Head::noSitename();
Head::doSitename();

// define description for <meta name="description"> tag
Head::setDescription('description');

// define a favicon for <link rel=""> tags (relative to public path, without extension)
Head::setFavicon('favicon');

您也可以通过填充空白来删除一个标签，例如

Head::setFavicon('');

多个布局

设置

您可以使用包的config.php中的任意多个布局来管理<head></head>部分的不同设置。您可以通过在配置文件末尾添加一个数组来覆盖一个或多个设置（有关更多信息，请参阅config.php中的注释），例如

'mylayout' => array(
    'charset' => 'ISO-8859-1',
    'twitter' => array(
        'image' => 'an-image.jpg',
    ),
),

在这里，您将只为名为'mylayout'的布局覆盖元字符集和twitter卡片图片的默认值。其他设置将使用默认值。

您还应该遵守路径结构

'layouts' => array(
    'custom' => array(
        'charset' => 'ISO-8859-1',
    ),
),

在这个例子中，您将在app/views/layouts目录中覆盖名为'custom'的布局的元字符集默认值。

注册自定义布局

为了使用自定义设置，您需要告诉您的应用程序您正在使用一个特定的布局，该布局可能调用除默认设置之外的设置。

在您的控制器或Blade布局中调用

Head::setLayout('mycustomlayout');

使用Laravel的工具自动管理自定义布局的一种简单方法是向BaseController.php添加一个构造函数

<?php

class BaseController extends Controller {

    public function __construct()
    {
        if ( ! is_null($this->layout))
        {
            Head::setLayout($this->layout);
        }
    }

    /**
    * Setup the layout used by the controller.
    *
    * @return void
    */
    protected function setupLayout()
    {   
        if ( ! is_null($this->layout))
        {
            $this->layout = View::make($this->layout);
        }
    }
}

这样，当您在控制器中使用protected $layout = 'mylayout';设置布局时，您也将自动为该包的方法注册您的布局。

特殊工具

搜索引擎

默认情况下，当不在生产模式时，Head::render()方法将通过在您的<head></head>部分添加内容来防止您的网站被爬取和索引

<meta name="robots" content="none">
Internet Explorer兼容性

Head::render() 方法还可以自动渲染两个强制 IE 兼容性的常用标签。在 config.php 中设置默认值（布尔值）为 'ie_edge' => true|false, 和 'html5_shiv' => true|false, 以显示

// ie_edge is true
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">

// html5_shiv is true
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->

您还可以使用以下方式覆盖当前请求的默认设置：

// de|activate ie_edge
Head::noIeEdge();
Head::doIeEdge();

// de|activate html5_shiv
Head::noShiv();
Head::doShiv();
响应式设计

如果将 config.php 中的 'responsive' => true|false, 设置为 true，则可以自动显示响应式设计常用的标签。它将渲染

// responsive set to true
<meta name="viewport" content="width=device-width, initial-scale=1.0">

您还可以使用以下方式覆盖当前请求的默认设置：

// de|activate responsive
Head::noResponsive();
Head::doResponsive();

元标签

基本用法

您可以在您的路由或控制器中设置所需的任何数量的元标签

Head::addMeta(array('type' => array('value' => 'content')));

例如

Head::addMeta(array(
	'name' => array(
		'copyright' => 'My Company',
		'author' => 'Me',
	),
	'http-equiv' => array(
		'pragma' => 'no-cache',
	),
	'property' => array(
		'og:title' => 'Title for Open Graph',
	),
));

将渲染

<meta name="copyright" content="My Company">
<meta name="author" content="Me">
<meta http-equiv="pragma" content="no-cache">
<meta property="og:title" content="Title for Open Graph">

如果您只需添加一个元标签，您也可以使用

Head::addOneMeta('type', 'value', 'content');
开放图

如果您在 config.php 中激活了它，Head::render() 方法可以自动显示为 Facebook 开放图协议的一组元标签。您也可以设置一些默认值。如果没有定义值或文件不存在，则不会显示任何标签。

// rendered HTML in <head></head> section if facebook's active is set to true in config.php
<meta property="fb:page_id" content="set in config.php">
<meta property="fb:app_id" content="set in config.php">
<meta property="fb:admins" content="set in config.php">
<meta property="og:image" content="set in config.php">
<meta property="og:url" content="current url">
<meta property="fb:type" content="website">
<meta property="og:site_name" content="default sitename set in config.php">
<meta property="og:title" content="same as title tag">
<meta property="og:description" content="same as description meta tag">

您可以使用以下方式为当前请求禁用 Open Graph：

Head::noFacebook();
Head::doFacebook();

禁用还将删除您使用 Head::addMeta() 和 Head::addOneMeta() 方法手动定义的 Open Graph 标签。

Twitter 卡

如果您在 config.php 中激活它，Head::render() 方法可以自动显示为 Twitter 卡的一组元标签。您也可以设置一些默认值。如果没有定义值或文件不存在，则不会显示任何标签。

// rendered HTML in <head></head> section if twitter's active is set to true in config.php
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="same as title tag">
<meta name="twitter:description" content="same as description meta tag">
<meta name="twitter:image:src" content="set in config.php">
<meta name="twitter:site" content="set in config.php">
<meta name="twitter:creator" content="set in config.php">
<meta name="twitter:url" content="current url">

您可以使用以下方式为当前请求禁用 Twitter 卡：

Head::noTwitter();
Head::doTwitter();

禁用还将删除您使用 Head::addMeta() 和 Head::addOneMeta() 方法手动定义的 Twitter 卡标签。

覆盖

您可以通过使用 Head::addMeta() 或 Head::addOneMeta() 方法重新声明它来覆盖任何元标签的任何值。它还将覆盖 config.php 中设置的默认值。例如，您可以在控制器的构造函数中为元标签定义一个默认值，并在其某个操作中覆盖它，以针对特定请求：

<?php

class FrontController extends BaseController {

	protected $layout = 'mylayout';

	function __construct()
	{
		Head::addOneMeta('name', 'author', 'Me');
	}

	public function index()
	{
		return View::make('home');
	}

	public function anotherPage()
	{
		Head::addOneMeta('name', 'author', 'Another Guy');
		return View::make('anotherpage');
	}

}

您可以通过将其填充为空来为特定请求删除元标签，例如执行以下操作：

Head::addOneMeta('name', 'author', '');

覆盖也适用于特殊的实用工具，如 <meta name="viewport"> 或 <meta http-equiv="X-UA-Compatible">，但不能用于单独工作的 <meta name="description">。

链接标签

您可以在您的路由或控制器中设置所需的任何数量的链接标签

Head::addLink(array(array('rel', 'href', 'type', array('attr' => 'value'), 'condition')));

类型、属性和条件是可选的。条件代表条件注释（有关更多信息，请参阅 样式表）。

例如

Head::addLink(array(
	array('canonical', 'http://domain.com/whatyouwant'),
	array('alternate', 'http://url-to-your-feed', 'application/rss+xml', array('title' => 'RSS')),
));

将渲染

<link rel="canonical" href="http://domain.com/whatyouwant">
<link rel="alternate" content="http://url-to-your-feed" type="application/rss+xml" title="RSS">

如果您需要添加仅一个链接标签，您也可以使用

Head::addOneLink('rel', 'href', 'type', array('attr' => 'value'), 'condition');

与元标签不同，您不能覆盖链接标签。

样式表

基本用法

您可以在您的路由或控制器中设置所需的任何数量的样式表

Head::addCss(array('file' => 'media'));

默认情况下，如果留空，媒体设置为 'all'。如果您需要条件注释，您也可以使用

Head::addCss(array('file' => array('media', 'condition')));

例如

Head::addCss(array(
	'firstfile' => 'screen and (min-width:480px)',
	'secondfile' => array('', 'lt IE 9'),
));

将渲染

<link rel="stylesheet" media="screen and (min-width:480px)" href="http://domain.com/firstfile.css">
<!--[if lt IE 9]><link rel="stylesheet" media="all" href="http://domain.com/secondfile.css"><![endif]-->

您也可以仅添加一个样式表

Head::addOneCss('file', 'media', 'condition');

其中媒体和条件是可选的。如果文件不存在，则不会显示该标签。

设置和外部资源

在 config.php 中，您可以定义 .css 文件的默认路径（assets -> paths -> css），相对于公共路径。因此，在添加样式表时，您应使用文件的路径和名称（不包含扩展名）从默认路径。

您还可以加载 config.php 中定义的外部资源（assets -> cdn）。您必须在 config.php 中添加样式表时使用与 cdn 相同的名称。

您不能覆盖样式表：样式表仅在尚未添加时才会渲染，因此请小心处理依赖关系。

脚本

脚本的管理方式与样式表相同

Head::addScript(array('file' => 'load'));
Head::addScript(array('file' => array('load', 'condition')));
Head::addOneScript('file', 'load', 'condition');

仅接受空白、'defer' 或 'async' 作为值。Load 和 condition 是可选的。您还可以在 config.php 中设置路径和 cdn。

Google 的通用分析

您可以通过在 config.php 中将 analytics 的 active 设置为 true，自动在 <head></head> 部分的末尾添加新的 Google 通用分析。别忘了添加您的产品 ID。如果不处于生产模式，则脚本将不会显示。默认情况下，通用分析脚本异步加载。

您也可以通过在 config.php 中填写 analytics 的脚本来覆盖脚本，例如如果您使用自定义方法或另一个服务提供商：粘贴完整的脚本，不包括 <script></script> 标签。

您可以使用以下方法禁用当前请求的脚本：

Head:noAnalytics();
Head:doAnalytics();

杂项

您可以使用以下方法在 <head></head> 部分的末尾添加任何额外的标签或自定义代码，如注释：

// several additions
Head::addMisc(array('First additional code', 'Second additional code', ...));
// or only one addition
Head::addMisc('My additional code');

快捷表

查看所有 可用方法 的摘要。