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

Revision 7196, 4.5 KB checked in by grum, 9 years ago (diff)

Commit first files

  • 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    if($param['subCat']=='y')
65    {
66      foreach($param['catIdList'] as $catId)
67      {
68        $returned.=" OR FIND_IN_SET($catId, ase_pct.uppercats) ";
69      }
70    }
71
72    return($returned);
73  }
74
75  /**
76   * the getJoin function must return a ready to use where allowing to join the
77   * IMAGES table (key : id) with given conditions
78   *
79   * "att3 = pit.id "
80   */
81  static public function getJoin($param="")
82  {
83    return("ase_pict.image_id = pit.id");
84  }
85
86
87  /**
88   * the getFilter function must return a ready to use where clause
89   * this where clause is used to filter the cache when the used tables can
90   * return more than one result
91   *
92   * the filter can be empty, can be equal to the where clause, or can be equal
93   * to a sub part of the where clause
94   *
95   */
96  static public function getFilter($param="")
97  {
98    return(self::getWhere($param));
99  }
100
101  /**
102   * this function is called by the request builder, allowing to display plugin
103   * data with a specific format
104   *
105   * @param Array $attributes : array of ('attribute_name' => 'attribute_value')
106   * @return String : HTML formatted value
107   */
108  static public function formatData($attributes)
109  {
110    /* attributes is an array :
111     *    Array(
112     *      'csColors' => 'color1,color2,color3,...,colorN',
113     *      'csColorsPct' => 'pct1,pct2,pct3,...,pctN'
114     *    );
115     */
116    $returned="<span style='font-weight:bold;'>".l10n('Category')."</span>&nbsp;:&nbsp;".$attributes['categoryName'];
117
118    return($returned);
119  }
120
121
122
123  /**
124   * this function is called by the request builder to make the search page, and
125   * must return the HTML & JS code of the dialogbox used to select criterion
126   *
127   * Notes :
128   *  - the dialogbox is a JS object with a public method 'show'
129   *  - when the method show is called, one parameter is given by the request
130   *    builder ; the parameter is an object defined as this :
131   *      {
132   *        cBuilder: an instance of the criteriaBuilder object used in the page,
133   *        eventOK : a callback function, called when the OK button is pushed
134   *        id:
135   *      }
136   *
137   *
138   *
139   *
140   * @param String $mode : can take 'admin' or 'public' values, allowing to
141   *                       return different interface if needed
142   * @return String : HTML formatted value
143   */
144  static public function getInterfaceContent($mode='admin')
145  {
146    return(ASE_functions::dialogBoxASECategory());
147  }
148
149  /**
150   * this function returns the label displayed in the criterion menu
151   *
152   * @return String : label displayed in the criterions menu
153   */
154  static public function getInterfaceLabel()
155  {
156    return(l10n('ase_add_category'));
157  }
158
159  /**
160   * this function returns the name of the dialog box class
161   *
162   * @return String : name of the dialogbox class
163   */
164  static public function getInterfaceDBClass()
165  {
166    return('dialogChooseASECategoryBox');
167  }
168
169}
170
171?>
Note: See TracBrowser for help on using the repository browser.