php semver
v3.0.0
Biblioteca de versiones semánticas para PHP. Implementa la especificación semántica completa de la versión 2.0.0 y proporciona la capacidad de analizar , comparar e incrementar versiones semánticas junto con validación frente a restricciones .
| Versión | Versión PHP |
|---|---|
>=1.0, <1.2 | >=5.5 |
>=1.2, <3.0 | >=7.1 |
>=3.0 | >=8.1 |
composer require z4kn4fein/php-semver Se admiten las siguientes opciones para construir una Version :
Construyendo parte por parte con Version::create() .
Version:: create ( 3 , 5 , 2 , " alpha " , " build " ); Análisis de una cadena con Version::parse() o Version::parseOrNull() .
Version:: parse ( " 3.5.2-alpha+build " ); Se puede acceder a la siguiente información en un objeto Version construido:
<?php
use z4kn4fein SemVer Version ;
$ version = Version:: parse ( " 2.5.6-alpha.12+build.34 " );
echo $ version -> getMajor (); // 2
echo $ version -> getMinor (); // 5
echo $ version -> getPatch (); // 6
echo $ version -> getPreRelease (); // alpha.12
echo $ version -> getBuildMeta (); // build.34
echo $ version -> isPreRelease (); // true
echo $ version -> isStable (); // false
echo $ version -> withoutSuffixes (); // 2.5.6
echo $ version ; // 2.5.6-alpha.12+build.34 De forma predeterminada, el analizador de versiones considera no válidas las versiones parciales como 1.0 y las versiones que comienzan con el prefijo v . Este comportamiento se puede desactivar estableciendo el parámetro strict en false .
echo Version:: parse ( " v2.3-alpha " ); // exception
echo Version:: parse ( " 2.1 " ); // exception
echo Version:: parse ( " v3 " ); // exception
echo Version:: parse ( " v2.3-alpha " , false ); // 2.3.0-alpha
echo Version:: parse ( " 2.1 " , false ); // 2.1.0
echo Version:: parse ( " v3 " , false ); // 3.0.0 Es posible comparar dos objetos Version con los siguientes métodos de comparación.
<?php
use z4kn4fein SemVer Version ;
// with static methods
echo Version:: lessThan ( " 2.3.4 " , " 2.4.1 " ); // true
echo Version:: lessThanOrEqual ( " 2.4.1 " , " 2.4.1 " ); // true
echo Version:: greaterThan ( " 2.3.1-alpha.5 " , " 2.3.1-alpha.3 " ); // true
echo Version:: greaterThanOrEqual ( " 3.2.3 " , " 3.2.2 " ); // true
echo Version:: equal ( " 3.2.3 " , " 3.2.3+build.3 " ); // true
echo Version:: notEqual ( " 3.2.3 " , " 2.2.4 " ); // true
// compare() or compareString()
echo Version:: compare (Version:: parse ( " 2.3.4 " ), Version:: parse ( " 2.4.1 " )); // -1
echo Version:: compare (Version:: parse ( " 2.3.4 " ), Version:: parse ( " 2.3.4 " )); // 0
echo Version:: compare (Version:: parse ( " 2.3.4 " ), Version:: parse ( " 2.2.0 " )); // 1
echo Version:: compareString ( " 2.3.4 " , " 2.4.1 " ); // -1
echo Version:: compareString ( " 2.3.4 " , " 2.3.4 " ); // 0
echo Version:: compareString ( " 2.3.4 " , " 2.2.0 " ); // 1
// with instance methods
$ version = Version:: parse ( " 2.5.6-alpha.12+build.34 " );
echo $ version -> isLessThan (Version:: parse ( " 2.3.1 " )); // false
echo $ version -> isLessThanOrEqual (Version:: parse ( " 2.5.6-alpha.15 " )); // true
echo $ version -> isGreaterThan (Version:: parse ( " 2.5.6 " )); // false
echo $ version -> isLessThanOrEqual (Version:: parse ( " 2.5.6-alpha.12 " )); // true
echo $ version -> isEqual (Version:: parse ( " 2.5.6-alpha.12+build.56 " )); // true
echo $ version -> isNotEqual (Version:: parse ( " 2.2.4 " )); // true Version::sort() y Version::sortString() están disponibles para ordenar una variedad de versiones.
<?php
use z4kn4fein SemVer Version ;
$ versions = array_map ( function ( string $ version ) {
return Version:: parse ( $ version );
}, [
" 1.0.1 " ,
" 1.0.1-alpha " ,
" 1.0.1-alpha.beta " ,
" 1.0.1-alpha.3 " ,
" 1.0.1-alpha.2 " ,
" 1.1.0 " ,
" 1.1.0+build " ,
]);
$ sorted = Version:: sort ( $ versions );
// The result:
// "1.0.1-alpha"
// "1.0.1-alpha.2"
// "1.0.1-alpha.3"
// "1.0.1-alpha.beta"
// "1.0.1"
// "1.1.0"
// "1.1.0+build" Es posible que desee ordenar en orden inverso, luego puede usar Version::rsort() o Version::rsortString() .
<?php
use z4kn4fein SemVer Version ;
$ versions = array_map ( function ( string $ version ) {
return Version:: parse ( $ version );
}, [
" 1.0.1 " ,
" 1.0.1-alpha " ,
" 1.0.1-alpha.beta " ,
" 1.0.1-alpha.3 " ,
" 1.0.1-alpha.2 " ,
" 1.1.0 " ,
" 1.1.0+build " ,
]);
$ sorted = Version:: rsort ( $ versions );
// The result:
// "1.1.0"
// "1.1.0+build"
// "1.0.1"
// "1.0.1-alpha.beta"
// "1.0.1-alpha.3"
// "1.0.1-alpha.2"
// "1.0.1-alpha" Los métodos Version::compare() y Version::compareString() también se pueden usar como devolución de llamada para usort() para ordenar una serie de versiones.
<?php
use z4kn4fein SemVer Version ;
$ versions = array_map ( function ( string $ version ) {
return Version:: parse ( $ version );
}, [
" 1.0.1 " ,
" 1.0.1-alpha " ,
" 1.0.1-alpha.beta " ,
" 1.0.1-alpha.3 " ,
" 1.0.1-alpha.2 " ,
" 1.1.0 " ,
" 1.1.0+build " ,
]);
usort ( $ versions , [ " z4kn4feinSemVerVersion " , " compare " ]);
// The result:
// "1.0.1-alpha"
// "1.0.1-alpha.2"
// "1.0.1-alpha.3"
// "1.0.1-alpha.beta"
// "1.0.1"
// "1.1.0"
// "1.1.0+build" Con restricciones, es posible validar si una versión satisface un conjunto de reglas o no. Una restricción se puede describir como una o más condiciones combinadas con operadores lógicos OR y AND .
Las condiciones suelen estar compuestas por un operador de comparación y una versión como >=1.2.0 . La condición >=1.2.0 la cumpliría cualquier versión mayor o igual a 1.2.0 .
Operadores de comparación admitidos:
= Igual (equivale a ningún operador: 1.2.0 significa =1.2.0 )!= No igual< Menos de<= Menor o igual> Mayor que>= Mayor o igual que Las condiciones se pueden unir con espacios en blanco, que representan el operador lógico AND entre ellas. El operador OR se puede expresar con || o | entre conjuntos de condiciones.
Por ejemplo, la restricción >=1.2.0 <3.0.0 || >4.0.0 se traduce en: Solo se permiten aquellas versiones que sean mayores o iguales a 1.2.0 { AND } menores que 3.0.0 { OR } mayores que 4.0.0 .
Podemos notar que la primera parte de la restricción anterior ( >=1.2.0 <3.0.0 ) es un rango de versión semántica simple. Hay más formas de expresar rangos de versiones; La siguiente sección repasará todas las opciones disponibles.
Hay indicadores de rango particulares que son azúcares para expresiones de rango más amplio.
Rango X : los caracteres x , X y * se pueden utilizar como comodín para las partes numéricas de una versión.
1.2.x se traduce en >=1.2.0 <1.3.0-01.x se traduce en >=1.0.0 <2.0.0-0* se traduce en >=0.0.0En expresiones de versión parcial, los números que faltan se tratan como comodines.
1.2 significa 1.2.x que finalmente se traduce en >=1.2.0 <1.3.0-01 significa 1.x o 1.xx que finalmente se traduce en >=1.0.0 <2.0.0-0Rango de guiones : describe un rango de versiones inclusivo. Los comodines se evalúan y se tienen en cuenta en el rango final.
1.0.0 - 1.2.0 se traduce en >=1.0.0 <=1.2.01.1 - 1.4.0 significa >=(>=1.1.0 <1.2.0-0) <=1.4.0 que finalmente se traduce en >=1.1.0 <=1.4.01.1.0 - 2 significa >=1.1.0 <=(>=2.0.0 <3.0.0-0) que finalmente se traduce en >=1.1.0 <3.0.0-0 Rango de tilde ( ~ ) : describe un rango de nivel de parche cuando se especifica la versión menor o un rango de nivel menor cuando no lo es.
~1.0.1 se traduce en >=1.0.1 <1.1.0-0~1.0 se traduce en >=1.0.0 <1.1.0-0~1 se traduce en >=1.0.0 <2.0.0-0~1.0.0-alpha.1 se traduce en >=1.0.1-alpha.1 <1.1.0-0 Rango de intercalación ( ^ ) : describe un rango con respecto a la parte más a la izquierda distinta de cero de la versión.
^1.1.2 se traduce en >=1.1.2 <2.0.0-0^0.1.2 se traduce en >=0.1.2 <0.2.0-0^0.0.2 se traduce en >=0.0.2 <0.0.3-0^1.2 se traduce en >=1.2.0 <2.0.0-0^1 se traduce en >=1.0.0 <2.0.0-0^0.1.2-alpha.1 se traduce en >=0.1.2-alpha.1 <0.2.0-0Veamos cómo podemos determinar si una versión satisface una restricción o no.
<?php
use z4kn4fein SemVer Version ;
use z4kn4fein SemVer Constraints Constraint ;
$ constraint = Constraint:: parse ( " >=1.2.0 " );
$ version = Version:: parse ( " 1.2.1 " );
echo $ version -> isSatisfying ( $ constraint ); // true
echo $ constraint -> isSatisfiedBy ( $ version ); // true
// Or using the static satisfies() method with strings:
echo Version:: satisfies ( " 1.2.1 " , " >=1.2.0 " ); // true Los objetos Version pueden producir versiones incrementadas de sí mismos con los métodos getNext{Major|Minor|Patch|PreRelease}Version . Estos métodos se pueden utilizar para determinar la siguiente versión en orden incrementado por la pieza correspondiente. Los objetos Version son inmutables , por lo que cada función incremental crea una nueva Version .
Este ejemplo muestra cómo funciona el incremento en una versión estable:
<?php
use z4kn4fein SemVer Version ;
use z4kn4fein SemVer Inc ;
$ stableVersion = Version:: create ( 1 , 0 , 0 );
echo $ stableVersion -> getNextMajorVersion (); // 2.0.0
echo $ stableVersion -> getNextMinorVersion (); // 1.1.0
echo $ stableVersion -> getNextPatchVersion (); // 1.0.1
echo $ stableVersion -> getNextPreReleaseVersion (); // 1.0.1-0
// or with the inc() method:
echo $ stableVersion -> inc (Inc:: MAJOR ); // 2.0.0
echo $ stableVersion -> inc (Inc:: MINOR ); // 1.1.0
echo $ stableVersion -> inc (Inc:: PATCH ); // 1.0.1
echo $ stableVersion -> inc (Inc:: PRE_RELEASE ); // 1.0.1-0En caso de una versión inestable:
<?php
use z4kn4fein SemVer Version ;
use z4kn4fein SemVer Inc ;
$ unstableVersion = Version:: parce ( " 1.0.0-alpha.2+build.1 " );
echo $ unstableVersion -> getNextMajorVersion (); // 2.0.0
echo $ unstableVersion -> getNextMinorVersion (); // 1.1.0
echo $ unstableVersion -> getNextPatchVersion (); // 1.0.0
echo $ unstableVersion -> getNextPreReleaseVersion (); // 1.0.0-alpha.3
// or with the inc() method:
echo $ unstableVersion -> inc (Inc:: MAJOR ); // 2.0.0
echo $ unstableVersion -> inc (Inc:: MINOR ); // 1.1.0
echo $ unstableVersion -> inc (Inc:: PATCH ); // 1.0.0
echo $ unstableVersion -> inc (Inc:: PRE_RELEASE ); // 1.0.0-alpha.3Cada función incremental proporciona la opción de establecer una identidad previa al lanzamiento en la versión incrementada.
<?php
use z4kn4fein SemVer Version ;
use z4kn4fein SemVer Inc ;
$ version = Version:: parce ( " 1.0.0-alpha.1 " );
echo $ version -> getNextMajorVersion ( " beta " ); // 2.0.0-beta
echo $ version -> getNextMinorVersion ( "" ); // 1.1.0-0
echo $ version -> getNextPatchVersion ( " alpha " ); // 1.0.1-alpha
echo $ version -> getNextPreReleaseVersion ( " alpha " ); // 1.0.0-alpha.2
// or with the inc() method:
echo $ version -> inc (Inc:: MAJOR , " beta " ); // 2.0.0-beta
echo $ version -> inc (Inc:: MINOR , "" ); // 1.1.0-0
echo $ version -> inc (Inc:: PATCH , " alpha " ); // 1.0.1-alpha
echo $ version -> inc (Inc:: PRE_RELEASE , " alpha " ); // 1.0.0-alpha.2 Es posible hacer una copia de una versión particular con el método copy() . Permite alterar las propiedades de la versión copiada con parámetros opcionales.
$ version = Version:: parse ( " 1.0.0-alpha.2+build.1 " );
echo $ version -> copy (); // 1.0.0-alpha.2+build.1
echo $ version -> copy ( 3 ); // 3.0.0-alpha.2+build.1
echo $ version -> copy ( null , 4 ); // 1.4.0-alpha.2+build.1
echo $ version -> copy ( null , null , 5 ); // 1.0.5-alpha.2+build.1
echo $ version -> copy ( null , null , null , " alpha.4 " ); // 1.0.0-alpha.4+build.1
echo $ version -> copy ( null , null , null , null , " build.3 " ); // 1.0.0-alpha.2+build.3
echo $ version -> copy ( 3 , 4 , 5 ); // 3.4.5-alpha.2+build.1 Nota
Sin establecer ningún parámetro opcional, el método copy() producirá una copia exacta de la versión original.
Cuando el análisis de la versión o la restricción falla debido a un formato no válido, la biblioteca genera una SemverException específica.
Nota
Los métodos Version::parseOrNull() y Constraint::parseOrNull() se pueden utilizar para conversiones sin excepciones, ya que devuelven null cuando falla el análisis.
