Semantic MediaWiki and related extensions
Public Member Functions | Protected Attributes | List of all members
SMW\Options Class Reference
Inheritance diagram for SMW\Options:
Inheritance graph
[legend]

Public Member Functions

 __construct (array $options=[])
 
 set ( $key, $value)
 
 delete ( $key)
 
 has ( $key)
 
 is ( $key, $value)
 
 get ( $key)
 
 safeGet ( $key, $default=false)
 
 dotGet ( $key, $default=false)
 
 isFlagSet ( $key, $flag)
 
 toArray ()
 
 getOptions ()
 
 filter (array $keys)
 

Protected Attributes

 $options = []
 

Detailed Description

GNU GPL v2+

Since
2.3
Author
mwjames

Constructor & Destructor Documentation

◆ __construct()

SMW\Options::__construct ( array  $options = [])
Since
2.3

Member Function Documentation

◆ delete()

SMW\Options::delete (   $key)
Since
3.0
Parameters
string$key

◆ dotGet()

SMW\Options::dotGet (   $key,
  $default = false 
)
Since
3.0
Parameters
string$key
mixed$default
Returns
mixed

◆ filter()

SMW\Options::filter ( array  $keys)
Since
3.0
Parameters
array$keys
Returns
array

◆ get()

SMW\Options::get (   $key)
Since
2.3
Parameters
string$key
Returns
string
Exceptions
InvalidArgumentException

◆ getOptions()

SMW\Options::getOptions ( )
Deprecated:
since 3.0, use Options::toArray
Since
2.4
Returns
array

◆ has()

SMW\Options::has (   $key)
Since
2.3
Parameters
string$key
Returns
boolean

◆ is()

SMW\Options::is (   $key,
  $value 
)
Since
3.0
Parameters
string$key
string$value
Returns
boolean

◆ isFlagSet()

SMW\Options::isFlagSet (   $key,
  $flag 
)
Since
3.0
Parameters
string$key
integer$flag
Returns
boolean

◆ safeGet()

SMW\Options::safeGet (   $key,
  $default = false 
)
Since
3.0
Parameters
string$key
mixed$default
Returns
mixed

◆ set()

SMW\Options::set (   $key,
  $value 
)
Since
2.3
Parameters
string$key
mixed$value

◆ toArray()

SMW\Options::toArray ( )
Since
3.0
Returns
array

The documentation for this class was generated from the following file:

About | General disclaimer | Privacy policy