pickles2/px2-px2dthelper v2.2.1 API Document

packages
in package

packages.php

Table of Contents

$main  : mixed
px2dthelper main
$px  : mixed
Picklesオブジェクト
__construct()  : mixed
constructor
get_package_list()  : array<string|int, mixed>
パッケージの一覧を取得する
get_path_composer_root_dir()  : string
composer root を取得 `composer.json` が設置されているディレクトリのパスを返します。
get_path_npm_root_dir()  : string
npm root を取得 `package.json` が設置されているディレクトリのパスを返します。
parse_broccoli_in_broccoli_json_row()  : object
broccoli.json を調査してパッケージ情報を抽出する
parse_package_dir()  : object
ディレクトリを解析してパッケージ情報を抽出する
parse_px2package_in_composer_json_row()  : object
px2package を調査してパッケージ情報を抽出する

Properties

$main

px2dthelper main

private mixed $main

$px

Picklesオブジェクト

private mixed $px

Methods

__construct()

constructor

public __construct(object $px, object $main) : mixed
Parameters
$px : object

$pxオブジェクト

$main : object

main.php のインスタンス

Return values
mixed

get_package_list()

パッケージの一覧を取得する

public get_package_list() : array<string|int, mixed>
Return values
array<string|int, mixed>

パッケージの一覧

get_path_composer_root_dir()

composer root を取得 `composer.json` が設置されているディレクトリのパスを返します。

public get_path_composer_root_dir() : string
Return values
string

composer.json が設置されているディレクトリのパス

get_path_npm_root_dir()

npm root を取得 `package.json` が設置されているディレクトリのパスを返します。

public get_path_npm_root_dir() : string
Return values
string

package.json が設置されているディレクトリのパス

parse_broccoli_in_broccoli_json_row()

broccoli.json を調査してパッケージ情報を抽出する

private parse_broccoli_in_broccoli_json_row(object $row, int $idx_num, string $path_dir, object $package_list) : object
Parameters
$row : object

1件分のパッケージ情報

$idx_num : int

インデックス番号

$path_dir : string

対象ディレクトリのパス

$package_list : object

一覧を格納するオブジェクト

Return values
object

更新された $package_list

parse_package_dir()

ディレクトリを解析してパッケージ情報を抽出する

private parse_package_dir(string $path_dir, object $package_list) : object
Parameters
$path_dir : string

対象ディレクトリのパス

$package_list : object

一覧を格納するオブジェクト

Return values
object

更新された $package_list

parse_px2package_in_composer_json_row()

px2package を調査してパッケージ情報を抽出する

private parse_px2package_in_composer_json_row(object $row, int $idx_num, string $path_dir, object $package_list) : object
Parameters
$row : object

1件分のパッケージ情報

$idx_num : int

インデックス番号

$path_dir : string

対象ディレクトリのパス

$package_list : object

一覧を格納するオブジェクト

Return values
object

更新された $package_list

Search results