PHP Class RTMediaQuery, rtMedia

Author: saurabh
Show file Open project: rtCamp/rtMedia

Public Properties

Property Type Description
$action_query The current action object (edit/delete/custom)
$actions The actions recognised for the object
$current_media
$format
$in_the_media_loop
$media
$media_count
$media_query The query arguments for the current instance (variable)
$original_query
$query The query arguments for the current instance
$shortcode_global

Public Methods

Method Description
__construct ( array | boolean $args = false ) Initialise the query
album_or_media ( ) }
get_data ( ) : type
get_media_by_media_id ( type $id ) : null helper method to find the array entry for the given media id
get_media_id ( type $media ) : type helper method to fetch media id of each media from the map
get_user ( )
have_media ( ) : boolean Checks at any point of time any media is left to be processed in the db pool
init ( ) Initialise the default args for the query
is_album ( )
is_album_gallery ( )
is_gallery ( )
is_group_album ( )
is_playlist ( )
is_playlist_gallery ( )
is_single ( )
is_single_edit ( )
next_media ( ) : type helper method for rt_album to move ahead in the db pool
order_by ( )
permalink ( )
populate_album ( )
populate_comments ( )
populate_data ( ) : boolean populate the data object for the page/album
populate_media ( )
populate_post_data ( type $media ) populate the post data for the fetched media from rtMedia context
privacy_filter ( $where, $table_name )
query ( type $query ) : type get media query for the request
register_set_gallery_template_filter ( $template, $attr )
rewind_media ( ) Rewinds the db pool of media album and resets it to begining
rtmedia ( ) : type moves ahead in the loop of media within the album
set_action_query ( )
set_actions ( ) additional actions to be added via action hook
set_json_format ( ) json request
set_media_type ( )
set_privacy ( )

Method Details

__construct() public method

Initialise the query
public __construct ( array | boolean $args = false )
$args array | boolean The query arguments

album_or_media() public method

}
public album_or_media ( )

get_data() public method

public get_data ( ) : type
return type

get_media_by_media_id() public method

helper method to find the array entry for the given media id
public get_media_by_media_id ( type $id ) : null
$id type
return null

get_media_id() public method

helper method to fetch media id of each media from the map
public get_media_id ( type $media ) : type
$media type
return type

get_user() public method

public get_user ( )

have_media() public method

Checks at any point of time any media is left to be processed in the db pool
public have_media ( ) : boolean
return boolean

init() public method

Initialise the default args for the query
public init ( )

is_album() public method

public is_album ( )

is_group_album() public method

public is_group_album ( )

is_playlist() public method

public is_playlist ( )

is_single() public method

public is_single ( )

is_single_edit() public method

public is_single_edit ( )

next_media() public method

helper method for rt_album to move ahead in the db pool
public next_media ( ) : type
return type

order_by() public method

public order_by ( )

populate_album() public method

public populate_album ( )

populate_comments() public method

public populate_comments ( )

populate_data() public method

populate the data object for the page/album
public populate_data ( ) : boolean
return boolean

populate_media() public method

public populate_media ( )

populate_post_data() public method

populate the post data for the fetched media from rtMedia context
public populate_post_data ( type $media )
$media type

privacy_filter() public method

public privacy_filter ( $where, $table_name )

query() public method

get media query for the request
public query ( type $query ) : type
$query type
return type

rewind_media() public method

Rewinds the db pool of media album and resets it to begining
public rewind_media ( )

rtmedia() public method

moves ahead in the loop of media within the album
public rtmedia ( ) : type
return type

set_action_query() public method

public set_action_query ( )

set_actions() public method

additional actions to be added via action hook
public set_actions ( )

set_json_format() public method

json request
public set_json_format ( )

set_media_type() public method

public set_media_type ( )

set_privacy() public method

public set_privacy ( )

Property Details

$action_query public property

The current action object (edit/delete/custom)
public $action_query

$actions public property

The actions recognised for the object
public $actions

$current_media public property

public $current_media

$format public property

public $format

$in_the_media_loop public property

public $in_the_media_loop

$media public property

public $media

$media_count public property

public $media_count

$media_query public property

The query arguments for the current instance (variable)
public $media_query

$original_query public property

public $original_query

$query public property

The query arguments for the current instance
public $query

$shortcode_global public property

public $shortcode_global