README

Laravel 存储过程

此包允许您使用 Laravel 4 与 PostgreSQL 存储过程进行工作。它允许您生成模型，以简化在 PHP 代码中使用存储过程。

安装

包安装

使用 Composer

通过在 composer.json 中添加以下依赖项来要求此包：

"mrblackus/laravel-storedprocedures": "0.1.*"

然后使用 composer update 或 composer install 更新 composer。

使用 Laravel Bundle

如果您不想使用 Composer，可以通过输入以下命令使用 Laravel Bundle 进行安装：

php artisan bundle:install StoredProcedure

注册服务提供者

安装包后，请将 ServiceProvider 添加到 app/config/app.php 中的 providers 数组中。

'providers' => array(
    'Mrblackus\LaravelStoredprocedures\LaravelStoredproceduresServiceProvider'
);

使用

您可以通过输入此命令为您的存储过程（即 函数）生成模型

php artisan generate-sp

只有以 sp_ 开头的存储过程才会生成模型，其他将被忽略。 模型将写入 app/store_procedures 目录（或配置文件中定义的目录）。不要编辑这些模型！ 下次生成时它们将被覆盖。

配置

您可以通过发布配置文件并编辑它来覆盖默认配置。

php artisan config:publish mrblackus/laravel-storedprocedures

您可以更改要读取的数据库模式以及存储过程模型写入的目录。

return array(
    'schema'         => 'public',
    'model_save_dir' => 'stored_procedures/'
);

模型

生成的模型有一个 execute() 方法，允许您执行存储过程并从其中获取结果（如果该过程返回一个）。

如果过程有 IN 或 INOUT 参数，则 execute() 方法将具有相同的参数和相同的顺序。

如果有 OUT 或 INOUT 参数，则模型将为每个 OUT 参数提供一个具有 getter/setter 的属性。

setter 不会修改数据，它们仅存在，以便您可以使用整个模型而不是简单的变量来格式化数据，如果您想在视图中使用它。

示例

以下存储过程用于检索用户的所有朋友，给出其 id...

CREATE OR REPLACE FUNCTION sp_getfriends(IN id integer, OUT id integer, OUT username character varying, OUT firstname character varying, OUT lastname character varying, OUT facebook_id character varying)
  RETURNS SETOF record AS
$BODY$SELECT id, username, firstname, lastname, facebook_id
FROM users
LEFT JOIN friends ON users.id = friends.friend_with_id
WHERE friends.user_id = $1$BODY$
  LANGUAGE sql VOLATILE
  COST 100
  ROWS 1000;

...我们将生成一个 SP_Getfriends 类。我们可以这样使用它：

$userId = 20;
$friends = SP_Getfriends::execute($userId);

$firstFriend = $friends[0];
$friend->getId();
$friend->getUsername();
$friend->getFacebookid();