Page Menu
Home
GitPull.it
Search
Configure Global Search
Log In
Files
F15182375
Opts.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Authored By
Unknown
Size
6 KB
Referenced Files
None
Subscribers
None
Opts.php
View Options
<?php
# boz-mw - Another MediaWiki API handler in PHP
# Copyright (C) 2018, 2019, 2020, 2021 Valerio Bozzolan
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# command line interface
namespace
cli
;
/**
* Register command line parameters and read their arguments
*/
class
Opts
{
/**
* All the registered parameters
*
* @var array
*/
private
$params
;
/**
* Internal flag cache
*
* @var bool
*/
private
$read
=
false
;
/**
* Constructor
*
* @param $params array Parameters
*/
public
function
__construct
(
$params
=
[
]
)
{
$this
->
register
(
$params
)
;
}
/**
* Static instance
*/
private
static
$_instance
;
/**
* Get a singleton instance
*
* @param $params array
* @return self
*/
public
static
function
instance
(
)
{
if
(
!
isset
(
self
::
$_instance
)
)
{
self
::
$_instance
=
new
self
(
)
;
}
return
self
::
$_instance
;
}
/**
* Register multiple parameters
*
* @param $params array
* @return self
*/
public
function
register
(
$params
)
{
foreach
(
$params
as
$param
)
{
$this
->
add
(
$param
)
;
}
return
$this
;
}
/**
* Register a new parameter
*
* @param $param object Parameter
* @return self
*/
public
function
add
(
Param
$param
)
{
$this
->
params
[
]
=
$param
;
$this
->
read
=
false
;
// invalidate the cache
return
$this
;
}
/**
* Add a flag option
*
* @param $long_name string Long name like 'is-enabled'
* @param $short_name string Short name like 'e'
* @param $description string Short human description
* @param $default_val
* @return self
*/
public
function
addFlag
(
$long_name
,
$short_name
=
null
,
$description
=
null
)
{
return
$this
->
add
(
new
ParamFlag
(
$long_name
,
$short_name
,
$description
)
)
;
}
/**
* Add a valued option
*
* @param $long_name string Long name like 'revision-text'
* @param $short_name string Short name like 'r'
* @param $description string Short human description
* @param $default_val string Default value
* @return self
*/
public
function
addValued
(
$long_name
,
$short_name
=
null
,
$description
=
null
,
$default_val
=
null
)
{
return
$this
->
add
(
new
ParamValued
(
$long_name
,
$short_name
,
$description
,
$default_val
)
)
;
}
/**
* Get a single argument
*
* @param $name string Param name (short or long)
* @param $default_val string Default param value
* @return string|null
*/
public
function
get
(
$name
,
$default_val
=
null
)
{
return
$this
->
populate
(
)
->
findParamFromName
(
$name
)
->
getValue
(
$default_val
)
;
}
/**
* Get all the registered parameters
*
* @return array
* @deprecated
*/
public
function
getAll
(
)
{
return
$this
->
params
;
}
/**
* Get all the unnamed arguments
*
* @return array
*/
public
static
function
unnamedArguments
(
)
{
$args
=
[
]
;
foreach
(
$GLOBALS
[
'argv'
]
as
$arg
)
{
if
(
'-'
!==
$arg
[
0
]
)
{
$args
[
]
=
$arg
;
}
}
array_shift
(
$args
)
;
return
$args
;
}
/**
* Print all the parameters in an human readable format
*/
public
function
printParams
(
)
{
foreach
(
$this
->
getParams
(
)
as
$param
)
{
$commands
=
[
]
;
if
(
$param
->
hasLongName
(
)
)
{
$commands
[
]
=
'--'
.
$param
->
getLongName
(
)
;
}
if
(
$param
->
hasShortName
(
)
)
{
$commands
[
]
=
'-'
.
$param
->
getShortName
(
)
;
}
$command
=
implode
(
'|'
,
$commands
)
;
if
(
$command
&&
!
$param
->
isFlag
(
)
)
{
$command
.=
$param
->
isValueOptional
(
)
?
'=[VALUE]'
:
'=VALUE'
;
}
printf
(
' % -20s '
,
$command
)
;
// eventually print an human description
if
(
$param
->
hasDescription
(
)
)
{
echo
' '
.
$param
->
getDescription
(
)
;
}
// eventually show the default value
if
(
$param
->
hasDefaultValue
(
)
)
{
printf
(
' (default VALUE: %s)'
,
$param
->
getDefaultValue
(
)
)
;
}
echo
"\n"
;
}
}
/**
* Populate all parameters with their arguments
*
* @see getopt()
* @return self
*/
public
function
populate
(
)
{
if
(
!
$this
->
read
)
{
// prepare getopt() syntax
$shorts
=
''
;
$longs
=
[
]
;
foreach
(
$this
->
params
as
$opt
)
{
$shorts
.=
$opt
->
getShortOptFormat
(
)
;
if
(
$opt
->
hasLongName
(
)
)
{
$longs
[
]
=
$opt
->
getLongOptFormat
(
)
;
}
}
// get command line arguments
$args
=
getopt
(
$shorts
,
$longs
)
;
// fill all parameters with their arguments
foreach
(
$this
->
params
as
$opt
)
{
// try with the short name
if
(
$opt
->
hasShortName
(
)
)
{
$name
=
$opt
->
getShortName
(
)
;
if
(
isset
(
$args
[
$name
]
)
)
{
$opt
->
setValue
(
$opt
->
isFlag
(
)
?
true
:
$args
[
$name
]
)
;
continue
;
}
}
// try with the long name
if
(
$opt
->
hasLongName
(
)
)
{
$name
=
$opt
->
getLongName
(
)
;
if
(
isset
(
$args
[
$name
]
)
)
{
$opt
->
setValue
(
$opt
->
isFlag
(
)
?
true
:
$args
[
$name
]
)
;
}
}
}
$this
->
read
=
true
;
}
return
$this
;
}
/**
* Find a registered param from a whatever name, the long or short on
*
* @param $name string Parameter name (long or short)
* @return Param
*/
protected
function
findParamFromName
(
$name
)
{
foreach
(
$this
->
params
as
$opt
)
{
if
(
$opt
->
isName
(
$name
)
)
{
return
$opt
;
}
}
throw
new
\
InvalidArgumentException
(
'unregistered parameter '
.
$name
)
;
}
/**
* Get all the registered parameters
*
* @return array
* @deprecated
*/
public
function
getParams
(
)
{
return
$this
->
getAll
(
)
;
}
/**
* Get a single argument
*
* @param $name string Param name (short or long)
* @param $default_val string Default param value
* @return string|null
* @deprecated
*/
public
function
getArg
(
$name
,
$default_val
=
null
)
{
return
$this
->
get
(
$name
,
$default_val
)
;
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Thu, Nov 19, 06:46 (10 h, 14 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
2265147
Default Alt Text
Opts.php (6 KB)
Attached To
Mode
R21 boz-mw: MediaWiki API client
Attached
Detach File
Event Timeline