etobi/coreapi

此包已被废弃,不再维护。未建议替换包。
此包的最新版本(1.3.0)没有可用的许可信息。

提供简单的API以实现常见核心功能。目标是能够通过CLI而不是后端/浏览器来完成大多数任务。

安装次数: 43,748

依赖项: 0

建议者: 0

安全: 0

星标: 60

关注者: 16

分支: 38

开放问题: 25

类型:typo3-cms-extension

1.3.0 2016-01-26 15:09 UTC

This package is auto-updated.

Last update: 2023-08-17 08:47:37 UTC


README

Stories in Ready Build Status Scrutinizer Code Quality Code Coverage

TYPO3扩展 'coreapi'

EXT:coreapi应提供简单的API以实现常见核心功能。目标是能够通过CLI而不是在后端/浏览器中完成大多数任务。

除了CLI命令之外,EXT:coreapi还提供服务类,可以在您的实现/扩展中使用。

请访问项目网站 forge.typo3.org: http://forge.typo3.org/projects/show/extension-coreapi

任务

  • DatabaseApi
    • databaseCompare
  • CacheApi
    • clearAllCaches
    • clearPageCache
    • clearConfigurationCache
  • ExtensionApi
    • info
    • listInstalled
    • updateList from TER
    • fetch an extension from TER
    • import an extension
    • install / uninstall extension
    • create upload folders
    • configure extension
  • SiteApi
    • info
    • createSysNews

计划/即将推出

  • 后端
    • 管理用户(列表、创建、更新、删除)
    • 锁定/解锁TYPO3后端
  • PageTree
    • 打印/获取
  • DataApi
    • 通用列表/创建/更新/删除记录(而不是直接执行SQL,而是使用DataHandler(即tcemain)!)
    • getRecordsByPid
    • 创建数据库转储(排除“临时”表,如缓存、sys_log等)
  • ReportsApi
    • 运行/检查报告模块中的报告
  • ConfigurationApi
    • 列出、获取和设置TYPO3配置

CLI调用

请确保您有一个名为 _cli_lowlevel 的后端用户

如果您想使用缓存清除命令,您需要将以下片段添加到此后端用户的TSconfig字段中

options.clearCache.all=1
options.clearCache.pages=1

TYPO3 6.2及以下

此扩展的版本0.2.0中删除了对TYPO3 CMS 6.2以下版本的支持。如果您需要与低于TYPO3 CMS 6.2的版本一起使用ext:coreapi,请使用版本 0.1.0-beta

TYPO3 6.2+

如果您使用的是TYPO3 6.2+,则可以使用Extbase的出色CommandController。

这将显示所有可用的调用 ./typo3/cli_dispatch.phpsh extbase help

在Composer中的使用

{
    "name": "typo3cms/test-website",
    "description": "TYPO3 CMS: test.com",
    "keywords": ["typo3", "cms"],
    "require": {
        "php": ">=5.3.3",
        "typo3core/cms": "*",
        "etobi/coreapi": "dev-master",
    },
    "extra": {
        "installer-paths": {
            "typo3conf/ext/{$name}": [
                "type:typo3-cms-extension"
            ]
        }
    },
    "minimum-stability": "dev",
    "require-dev": {},
    "scripts": {}
}

运行单元测试

单元测试依赖于vfsStream。由于某些原因,ext:coreapi不会自动添加这些依赖,而是使用为核心单元测试已定义的依赖项。要安装vfsStream,请将TYPO3 CMS包中的composer.json文件复制到您的webroot文件夹中,并执行命令composer install。这将安装所有依赖项到Packages/Libraries/。

然后运行单元测试。

cp typo3_src/composer.json .
composer install
./bin/phpunit --colors -c typo3/sysext/core/Build/UnitTests.xml typo3conf/ext/coreapi/Tests/Unit/