Arikaim CMS

Composer
in package

Composer commands

Table of Contents

Methods

getInstalledPackageInfo()  : array<string|int, mixed>|null
Get installed package info
getInstalledPackageVersion()  : string|false
Get installed package version
getLastVersion()  : string|false
Get package last version
getLocalPackagesInfo()  : array<string|int, mixed>
Get local package info
getPacakgeInfoUrl()  : string
Get package info url
getPackageData()  : array<string|int, mixed>|null
Get package data
getPackageInfo()  : array<string|int, mixed>|null
Get package info
isInstalled()  : bool
Return true if composer package is installed
readInstalledPackages()  : array<string|int, mixed>|false
Read local packages info file
removePackage()  : void
Run remove package command
requirePackage()  : void
Run require package command
run()  : void
Run composer commmand
updatePackage()  : void
Run update package command

Methods

getInstalledPackageInfo()

Get installed package info

public static getInstalledPackageInfo(string $name) : array<string|int, mixed>|null
Parameters
$name : string
Return values
array<string|int, mixed>|null

getInstalledPackageVersion()

Get installed package version

public static getInstalledPackageVersion(string $packageName[, string|null $path = null ]) : string|false
Parameters
$packageName : string
$path : string|null = null
Return values
string|false

getLastVersion()

Get package last version

public static getLastVersion(string $vendor, string $package) : string|false
Parameters
$vendor : string
$package : string
Return values
string|false

getLocalPackagesInfo()

Get local package info

public static getLocalPackagesInfo(array<string|int, mixed> $packagesList[, string|null $path = null ]) : array<string|int, mixed>
Parameters
$packagesList : array<string|int, mixed>
$path : string|null = null
Return values
array<string|int, mixed>

getPacakgeInfoUrl()

Get package info url

public static getPacakgeInfoUrl(string $vendor, string $package) : string
Parameters
$vendor : string
$package : string
Return values
string

getPackageData()

Get package data

public static getPackageData(string $vendor, string $package) : array<string|int, mixed>|null
Parameters
$vendor : string
$package : string
Return values
array<string|int, mixed>|null

getPackageInfo()

Get package info

public static getPackageInfo(string $vendor, string $package) : array<string|int, mixed>|null
Parameters
$vendor : string

Package vendor name

$package : string

Package name

Return values
array<string|int, mixed>|null

isInstalled()

Return true if composer package is installed

public static isInstalled(string|array<string|int, mixed> $packageList[, string|null $path = null ]) : bool
Parameters
$packageList : string|array<string|int, mixed>
$path : string|null = null
Return values
bool

readInstalledPackages()

Read local packages info file

public static readInstalledPackages([string|null $path = null ]) : array<string|int, mixed>|false
Parameters
$path : string|null = null
Return values
array<string|int, mixed>|false

removePackage()

Run remove package command

public static removePackage(string $packageName[, bool $quiet = true ]) : void
Parameters
$packageName : string
$quiet : bool = true

requirePackage()

Run require package command

public static requirePackage(string $packageName[, bool $quiet = true ]) : void
Parameters
$packageName : string
$quiet : bool = true

run()

Run composer commmand

public static run(string $command[, string|array<string|int, mixed>|null $packages = null ][, bool $quiet = false ]) : void
Parameters
$command : string
$packages : string|array<string|int, mixed>|null = null
$quiet : bool = false

updatePackage()

Run update package command

public static updatePackage(string $packageName[, bool $quiet = true ]) : void
Parameters
$packageName : string
$quiet : bool = true

        
On this page

Search results