Yii 프레임워크 공식 가이드 시리즈 50 - 특별 주제: 콘솔 애플리케이션

콘솔 애플리케이션은 주로 코드 생성, 검색 색인 편집, 이메일 전송 등과 같이 온라인 웹 애플리케이션에 필요한 오프라인 작업을 구현하는 데 사용됩니다. . Yii 프레임워크는 콘솔 애플리케이션이 온라인 웹 애플리케이션에서 사용하는 리소스(예: 데이터베이스 연결 정보)에 액세스할 수 있도록 하는 프레임워크를 제공합니다.

개요

Yii는 명령줄에서 각 콘솔 작업을 실행할 수 있습니다. 콘솔 명령은 CConsoleCommand에서 상속된 클래스입니다.

yiic webapp 도구를 사용하여 초기화된 Yii 애플리케이션 뼈대를 생성하면 보호된 폴더에서 다음 두 파일을 볼 수 있습니다.

• yiic: 이것은 Linux/Unix에서 실행되는 실행 스크립트;

• yiic.bat: Windows에서 실행되는 실행 가능한 배치 스크립트입니다.

콘솔 창에서 , 다음 명령을 입력할 수 있습니다:

cd protected
yiic help

이렇게 하면 일련의 콘솔 명령이 표시됩니다. 기본적으로 이러한 유효한 명령에는 Yii 프레임워크에서 제공하는 명령(시스템 명령)과 독립 실행형 응용 프로그램을 위해 개발자가 직접 작성한 명령(사용자 명령)이 포함됩니다.

명령 사용 방법을 보려면 다음을 사용하세요.

yiic help <command-name></command-name>

명령을 실행하려면 다음 명령 형식을 사용할 수 있습니다.

yiic <command-name> [parameters...]</command-name>

2. 명령 만들기

콘솔 명령은 CConsoleApplication::command와 같은 경로에 클래스 파일 형식으로 저장됩니다. 기본적으로 protected/ 폴더를 가리킵니다. 명령.

a 콘솔 명령 클래스는 CConsoleCommand에서 상속되어야 합니다. 클래스 이름은 XyzCommand 형식이어야 합니다. 여기서 Xyz는 첫 글자가 대문자인 명령 이름을 나타냅니다. 이름을 SitemapCommand로 지정하세요. 콘솔 명령 이름은 대소문자를 구분합니다.

팁:

CConsoleApplication::command 일치를 구성하면 다른 형식으로 명명되고 다른 클래스 폴더에 저장되는 명령을 얻을 수 있습니다.

새 명령을 생성하려면 CConsoleCommand::run()을 재정의하거나 하나 이상의 명령 작업을 개발해야 하는 경우가 많습니다.

콘솔 명령을 실행할 때 CConsoleCommand::run() 메서드는 콘솔 애플리케이션에 의해 호출됩니다. 모든 콘솔 매개변수는 다음 메소드 조각의 형태로 이 메소드에 전달됩니다.

public function run($args) { ... }

여기서 $args 줄로 제공된 명령 추가 매개변수를 나타냅니다.

콘솔 명령에서 Yii::app()을 사용하여 콘솔 애플리케이션 인스턴스에 액세스할 수 있을 뿐만 아니라 데이터베이스 연결과 같은 리소스에도 액세스할 수 있습니다(예: Yii::app()->). ;db) 이 사용법은 웹 애플리케이션의 사용법과 매우 유사하다는 것을 알 수 있습니다.

정보:

버전 1.1.1부터 동일한 시스템의 모든 Yii 애플리케이션이 공유하는 전역 명령을 생성할 수도 있습니다. YII_CONSOLE_COMMANDS라는 환경 변수를 정의합니다. 폴더로 이동한 다음 전역 명령 클래스를 이 폴더 아래에 배치합니다.

3. 콘솔 명령 액션(action)

참고:

이 콘솔 명령 액션 기능은 버전 1.1.5부터 유효합니다.

콘솔 명령은 다양한 명령줄 매개변수를 처리해야 하는 경우가 많으며 일부는 필수이고 일부는 선택 사항입니다. 콘솔 명령은 다양한 하위 작업을 처리하기 위해 일부 하위 명령도 제공해야 합니다. 이러한 작업은 콘솔 명령 작업을 사용하여 단순화할 수 있습니다.

콘솔 명령 작업은 콘솔 명령 클래스의 메서드입니다. 메서드 이름은 actionXyz 형식이어야 합니다. 여기서 Xyz는 첫 글자가 대문자로 표시된 작업 이름을 나타냅니다. 명명된 인덱스 작업.

특정 작업을 수행하려면 다음 명령줄 형식을 사용할 수 있습니다.

yiic <command-name> <action-name> --option1=value1 --option2=value2 ...</action-name></command-name>

추가 옵션-값 쌍이 명명된 매개변수로 작업 메서드에 전달됩니다. xyz 작업의 값은 $xyz 매개변수 형식으로 작업 메서드에 전달됩니다. 예를 들어, 다음 명령 클래스를 정의하면:

class SitemapCommand extends CConsoleCommand
{
    public function actionIndex($type, $limit=5) { ... }
    public function actionInit() { ... }
}

그러면 다음 콘솔 명령은 actionIndex( 'News ', 5)의 결과는 다음과 같습니다.

yiic sitemap index --type=News --limit=5

// $limit takes default value
yiic sitemap index --type=News

// $limit takes default value
// because 'index' is a default action, we can omit the action name
yiic sitemap --type=News

// the order of options does not matter
yiic sitemap index --limit=5 --type=News

작업에서 값을 지정하지 않으면(예: --type=News 대신 --type) 해당 작업 매개변수 값이 true로 간주됩니다.

참고:

는 선택적 매개변수 형식인 --type News, -t News를 지원하지 않습니다.

매개변수 값은 배열( 필수 배열 유형 힌트 필요):

public function actionIndex(array $types) { ... }

명령줄 매개변수에 배열 값을 사용하려면 간단히 동일한 옵션:

yiic sitemap index --types=News --types=Article

위 명령은 결국 actionIndex(array('News', 'Article'))를 호출합니다.

버전 1.1.6부터 Yii는 다음과 같은 사용도 지원합니다. 익명 작업 매개변수 및 전역 옵션.

匿名参数表示这些命令行参数不是以选项的形式呈现. 例如, 在命令 yiic sitemap index --limit=5 News中, 我们有一个值为News的匿名参数和命名参数 limit，其值为5。

为了使用匿名参数, 一个命令动作必须声明参数为 $args的形式. 例如,

public function actionIndex($limit=10, $args=array()) {...}

$args数组将会装入所有的匿名参数值.

全局选项代表那些命令行选项可以被一个命令中所有动作共享的选项. 例如, 在一个命令中提供了多个选项, 我们可能想要每一个动作识别一个名为verbose的动作. 当然我们可以在每一个动作方法中声明 $verbose 参数, 一个更好的方式是将其声明为这个命令类的公有成员变量, 将 verbose 转换为全局参数:

class SitemapCommand extends CConsoleCommand
{
    public $verbose=false;
    public function actionIndex($type) {...}
}

上面的代码允许我们执行一个带 verbose 选项的命令:

yiic sitemap index --verbose=1 --type=News

4. 退出代码

Note: 在控制台命令中退出代码的特性从版本 1.1.11起有效.

通过cronjob或者使用一个持续集成的服务器自动运行控制台命令的时候, 要么命令运行运行成功，要么命令运行失败. 这可以通过检查进程返回的退出代码来查看。

这些退出码是从0-254的整型值(this is the range in php world), 其中 0 表示退出成功其他的所有非0值表示出现了错误.

在一个动作方法或者控制台命令的 run() 方法中你可以在退出时返回整型值退出码 ，例如:

if (/* error */) {
    return 1; // exit with error code 1
}
// ... do something ...
return 0; // exit successfully

如果没有返回值, 应用将会退出返回 0.

5. 自定义控制台应用

默认情况下, 如果一个应用是使用yiic webapp工具创建的, 命令行应用的配置将会放在 protected/config/console.php文件中. 和一个Web应用配置文件一样, 这个文件是一个返回控制台应用实例的初始化配置值的数组的PHP脚本。所以CConsoleApplication的任何公有属性都可以在该文件中配置.

因为控制台命令经常被创建来服务于Web应用, 所以需要访问资源（如数据库连接）。我们可以在控制台配置文件中以如下方式来实现 ：

return array(
    ......
    'components'=>array(
        'db'=>array(
            ......
        ),
    ),
);

正如我们所看到的那样, 配置的格式和我们在Web应用中的配置类似.这是因为CConsoleApplication和 CWebApplication 的基类相同。

 以上就是Yii框架官方指南系列50——专题：控制台应用的内容，更多相关内容请关注PHP中文网（www.php.cn）！