depicter / app / src / DataSources / Base.php

Base.php in Depicter — Popup & Slider Builder 1.5.2, at app/src/DataSources/Base.php

55 lines 822 B

Raw Download Zip

1	<?php
2	namespace Depicter\DataSources;
3
4	abstract class Base
5	{
6	/**
7	* Source name
8	*
9	* @var string
10	*/
11	protected $type;
12
13	/**
14	* Input params to filter source result
15	*
16	* @var array
17	*/
18	protected $params;
19
20	/**
21	* List of valid dynamic tags for this source
22	*
23	* @var string[]
24	*/
25	protected $tags;
26
27	/**
28	* Prepares query arguments to get records
29	*
30	* @param array\|object $args
31	*
32	* @return array
33	*/
34	abstract protected function prepare( $args );
35
36	/**
37	* Renders preview for query params
38	*
39	* @param array $args
40	*
41	* @return array
42	*/
43	abstract public function previewRecords( array $args = [] );
44
45	/**
46	* Get list of tags and their values for the query result
47	*
48	* @param array $args
49	*
50	* @return array
51	*/
52	abstract public function getRecordsWithTags( array $args = [] );
53
54	}
55