source: extensions/ASearchEngine/ase_rb_callback_category.class.inc.php @ 7318

Revision 7318, 4.6 KB checked in by grum, 9 years ago (diff)

fix some bugs and implement public interface

  • Property svn:executable set to *
Line 
1<?php
2/* -----------------------------------------------------------------------------
3  Plugin     : Advanced Search Engine
4  Author     : Grum
5    email    : grum@piwigo.org
6    website  : http://photos.grum.fr
7
8    << May the Little SpaceFrog be with you ! >>
9  ------------------------------------------------------------------------------
10  See main.inc.php for release information
11
12
13  --------------------------------------------------------------------------- */
14
15  if(!defined('PHPWG_ROOT_PATH')) die('Hacking attempt!');
16
17  include_once(PHPWG_PLUGINS_PATH.'GrumPluginClasses/classes/GPCRequestBuilder.class.inc.php');
18
19load_language('plugin.lang', ASE_PATH);
20
21class RBCallBackASECategory extends GPCSearchCallback {
22
23  /**
24   * the getImageId returns the name of the image id attribute
25   * return String
26   */
27  static public function getImageId()
28  {
29    return("ase_pict.image_id");
30  }
31
32  /**
33   * the getSelect function must return an attribute list separated with a comma
34   *
35   * "att1, att2, att3, att4"
36   */
37  static public function getSelect($param="")
38  {
39    return(" ase_pct.id AS categoryId, ase_pct.name AS categoryName");
40  }
41
42  /**
43   * the getFrom function must return a tables list separated with a comma
44   *
45   * "table1, (table2 left join table3 on table2.key = table3.key), table4"
46   */
47  static public function getFrom($param="")
48  {
49    global $prefixeTable;
50
51    return("(".IMAGE_CATEGORY_TABLE." ase_pict JOIN ".CATEGORIES_TABLE." ase_pct
52      ON ase_pict.category_id = ase_pct.id) ");
53  }
54
55  /**
56   * the getWhere function must return a ready to use where clause
57   *
58   * "(att1 = value0 OR att2 = value1) AND att4 LIKE value2 "
59   */
60  static public function getWhere($param="")
61  {
62    global $user;
63
64    $returned=array();
65    if($param['subCat']=='y')
66    {
67      foreach($param['catIdList'] as $catId)
68      {
69        $returned[]=" FIND_IN_SET($catId, ase_pct.uppercats) ";
70      }
71    }
72
73    return(implode(' OR ', $returned));
74  }
75
76  /**
77   * the getJoin function must return a ready to use where allowing to join the
78   * IMAGES table (key : id) with given conditions
79   *
80   * "att3 = pit.id "
81   */
82  static public function getJoin($param="")
83  {
84    return("ase_pict.image_id = pit.id");
85  }
86
87
88  /**
89   * the getFilter function must return a ready to use where clause
90   * this where clause is used to filter the cache when the used tables can
91   * return more than one result
92   *
93   * the filter can be empty, can be equal to the where clause, or can be equal
94   * to a sub part of the where clause
95   *
96   */
97  static public function getFilter($param="")
98  {
99    return("");
100  }
101
102  /**
103   * this function is called by the request builder, allowing to display plugin
104   * data with a specific format
105   *
106   * @param Array $attributes : array of ('attribute_name' => 'attribute_value')
107   * @return String : HTML formatted value
108   */
109  static public function formatData($attributes)
110  {
111    /* attributes is an array :
112     *    Array(
113     *      'csColors' => 'color1,color2,color3,...,colorN',
114     *      'csColorsPct' => 'pct1,pct2,pct3,...,pctN'
115     *    );
116     */
117    $returned="<span style='font-weight:bold;'>".l10n('Category')."</span>&nbsp;:&nbsp;".$attributes['categoryName'];
118
119    return($returned);
120  }
121
122
123
124  /**
125   * this function is called by the request builder to make the search page, and
126   * must return the HTML & JS code of the dialogbox used to select criterion
127   *
128   * Notes :
129   *  - the dialogbox is a JS object with a public method 'show'
130   *  - when the method show is called, one parameter is given by the request
131   *    builder ; the parameter is an object defined as this :
132   *      {
133   *        cBuilder: an instance of the criteriaBuilder object used in the page,
134   *        eventOK : a callback function, called when the OK button is pushed
135   *        id:
136   *      }
137   *
138   *
139   *
140   *
141   * @param String $mode : can take 'admin' or 'public' values, allowing to
142   *                       return different interface if needed
143   * @return String : HTML formatted value
144   */
145  static public function getInterfaceContent($mode='admin')
146  {
147    return(ASE_functions::dialogBoxASECategory());
148  }
149
150  /**
151   * this function returns the label displayed in the criterion menu
152   *
153   * @return String : label displayed in the criterions menu
154   */
155  static public function getInterfaceLabel()
156  {
157    return(l10n('ase_add_category'));
158  }
159
160  /**
161   * this function returns the name of the dialog box class
162   *
163   * @return String : name of the dialogbox class
164   */
165  static public function getInterfaceDBClass()
166  {
167    return('dialogChooseASECategoryBox');
168  }
169
170}
171
172?>
Note: See TracBrowser for help on using the repository browser.