PHP Class Papi_Query, papi

Show file Open project: wp-papi/papi

Protected Properties

Property Type Description
$args array The query arguments.
$default_args array The default query arguments.
$query WP_Term_Query | WP_Query The query instance.
$type string The query type.

Public Methods

Method Description
__construct ( array $args = [], string $type = 'post' ) Query constructor.
__get ( string $key ) : mixed Dynamically access query properties.
first ( ) : array Get first item of result.
get_query_args ( ) : array Get real query arguments without Papi Query specific arguments.
get_query_class ( ) : WP_Query | WP_Term_Query Get query object for right query type.
get_result ( ) : array Get result.
last ( ) : array Get last item of result.
parse_args ( array $args ) Parse query arguments.

Protected Methods

Method Description
parse_post_args ( array $args ) : array Parse post query arguments.
parse_term_args ( array $args ) : array Parse term query arguments.

Method Details

__construct() public method

Query constructor.
public __construct ( array $args = [], string $type = 'post' )
$args array
$type string

__get() public method

Dynamically access query properties.
public __get ( string $key ) : mixed
$key string
return mixed

first() public method

Get first item of result.
public first ( ) : array
return array

get_query_args() public method

Get real query arguments without Papi Query specific arguments.
public get_query_args ( ) : array
return array

get_query_class() public method

Get query object for right query type.
public get_query_class ( ) : WP_Query | WP_Term_Query
return WP_Query | WP_Term_Query

get_result() public method

Works for all query types.
public get_result ( ) : array
return array

last() public method

Get last item of result.
public last ( ) : array
return array

parse_args() public method

Parse query arguments.
public parse_args ( array $args )
$args array

parse_post_args() protected method

Parse post query arguments.
protected parse_post_args ( array $args ) : array
$args array
return array

parse_term_args() protected method

Parse term query arguments.
protected parse_term_args ( array $args ) : array
$args array
return array

Property Details

$args protected property

The query arguments.
protected array $args
return array

$default_args protected property

The default query arguments.
protected array $default_args
return array

$query protected property

The query instance.
protected WP_Term_Query|WP_Query $query
return WP_Term_Query | WP_Query

$type protected property

The query type.
protected string $type
return string