A class to control the basic common functionality of all meeting searches. More...
Public Member Functions | |
| __construct ($in_results_per_page=0, c_comdef_meeting_search_manager &$in_parent=null, c_comdef_meetings &$in_search_results=null, $in_pageno=0) | |
| Constructor. | |
| SetFormats () | |
| Sets an internal array of integers, containing the Shared IDs for all available formats on the server. They are initialized to 0 (neutral). | |
| & | GetFormats () |
| Accessor -Get a reference to the $_formats field. | |
| SetKeyValueSearch ($in_meeting_key, $in_meeting_key_value, $in_meeting_key_match_case=false, $in_meeting_key_contains=true) | |
| Sets a key/value search. | |
| SetSortByDistance ($in_sort_search_by_distance=false) | |
| Sets the sort by distance flag. | |
| SetServiceBodies () | |
| Sets an internal array of integers, containing the IDs for all available service bodies on the server. They are initialized to 0 (neutral). | |
| GetResultsPerPage () | |
| Accessor -Get the number of results per page. | |
| SetResultsPerPage ($in_results_per_page) | |
| Accessor -Set the number of results per page. This will only work on the root object. | |
| GetPageNo () | |
| Accessor -Get the page number of this set. | |
| GetFirstIndexInPage () | |
| Accessor -Get the index (1 - based) of the first meeting in this page. | |
| GetLastIndexInPage () | |
| Accessor -Get the index (1 - based) of the last meeting in this page. | |
| GetNumberOfPages () | |
| Accessor -Get the page number of this set. | |
| GetNumberOfResults () | |
| Accessor -Get the total number of meetings found. This gives the TOTAL number found, not just the subset in this page. | |
| GetNumberOfResultsInThisPage () | |
| Accessor -Get the number of meetings in this page. | |
| & | GetPageOfResults ($in_page_no=1) |
| Accessor -Get the number of meetings in this page. | |
| & | GetServiceBodies () |
| Accessor -Get a reference to the $_service_bodies field. | |
| SetLanguages () | |
| Sets up an internal array of languages. The array uses the language enum as the key, and the -1->0->1 form as the selector. | |
| & | GetLanguages () |
| Accessor -Get a reference to the $_languages field. | |
| & | GetWeekdays () |
| Accessor -Get a reference to the $_weekdays field. | |
| & | GetServer () |
| Accessor -Get a reference to the c_comdef_server object. | |
| & | GetRootObject () |
| Accessor -Get a reference to the root object. | |
| SetSearchRadiusAndCenterInMiles ($in_search_radius_in_miles, $in_long_in_degrees, $in_lat_in_degrees) | |
| Set a search radius and center, with the Radius in miles. | |
| SetSearchRadiusAndCenterInKm ($in_search_radius_in_km, $in_long_in_degrees, $in_lat_in_degrees) | |
| Set a search radius and center, with the radius in Km. | |
| SetSearchRadiusAndCenterAuto ($in_search_result_count, $in_long_in_degrees, $in_lat_in_degrees) | |
| Set a search center, and a count for an auto radius hunt. The way this works is that the center is set, and the optimal radius is selected in kilometers to deliver that many meetings. The radius starts at 25 Km (about 10 miles), and goes up or down in 5Km "clicks." Under 5Km, it reduces to 0.5Km "clicks." It will not go out more than 100Km. | |
| GetRadius ($in_miles=false) | |
| Get the search radius. | |
| GetLongitude () | |
| Get the longitude. | |
| GetLatitude () | |
| Get the latitude. | |
| GetPublished () | |
| Get the search for published value. | |
| SetPublished ($in_published_search) | |
| Sets the search for published value. | |
| SetStartTime ($in_starts_after, $in_starts_before=null) | |
| Set a start time window. | |
| GetStartTime_Min () | |
| Get the "starts after" value. | |
| GetStartTime_Max () | |
| Get the "starts before" value. | |
| SetDuration ($in_max_duration, $in_min_duration=null) | |
| Set a duration time window. | |
| GetDuration_Max () | |
| Get the Maximum Duration value. | |
| GetDuration_Min () | |
| Get the Minimum Duration value. | |
| SetSearchString ($in_search_string, $in_all_words=false, $in_literal=false) | |
| Set a search string. | |
| & | GetSearchString () |
| Get the current search string. | |
| SetMeetingIDArray ($in_meeting_id_array) | |
| Set the current search string. | |
| & | GetMeetingIDArray () |
| Get the current search string. | |
| StringSearchForAllWords () | |
| Get the current search string "all words" flag. | |
| StringSearchIsLiteral () | |
| Get the current search string literal flag. | |
| & | GetAvailableLanguages () |
| These functions will help the caller to get information from the server. You can use them to build a search form. | |
| & | GetAvailableServiceBodies () |
| Returns an array of references to c_comdef_service_body objects. | |
| & | GetAvailableFormats () |
| Returns a multi-dimensional array of references to c_comdef_format objects. | |
| GetSpecificSortKeys () | |
| These functions deal with the search itself. | |
| DoSearch () | |
| Executes a new search. It will always force a new search. | |
| & | GetSearchResults_Obj ($in_new_search=false) |
| Returns a reference to the c_comdef_meetings object that contains the results of the search. If this is null, or if the $in_new_search parameter is set to true, the search will be executed, otherwise, this just returns a reference to the existing search results. | |
| ClearSearch () | |
| Clears the search results, so the next access will redo the search. | |
| & | GetSearchResultsAsArray () |
| This will return the search results as an array of c_comdef_meeting objects. | |
| ClearSort () | |
| These are sorting functions. | |
| SetSortDepth ($in_new_depth=0) | |
| Accessor. Set the maximum number of sorts to maintain. If the current number is more than the new value, then we remove any beyond that. | |
| SetTopSortPriority ($in_new_top_sort_key, $in_desc=false) | |
| Set a new "top" sort priority. | |
| SetSort ($in_sort_fields_array=null, $in_desc=false, $in_max_sort_keys=0) | |
| Sets up the sort array and direction. This replaces the entire array and direction. If the array is longer than the maximum number of sort keys, only that number of keys are used. | |
| SortMeetingObjects ($in_sort_fields_array=null, $in_desc=null) | |
| Sorts the meetings. This will apply a sort, dependent upon the given fields. The given array contains the field names (SQL columns and keys) for the data to be sorted. | |
| GetSquareForRadius ($in_weekday_tinyint_array) | |
| These are various utility functions. | |
Static Public Member Functions | |
| static | GetAllAvailableSortKeys () |
| Returns an array of all possible field keys to be used for sorting. | |
| static | GetSingleMeetingByID ($in_id) |
| These are static functions for directly accessing meetings via ID. | |
| static | GetMultipleMeetingsByID ($in_id_array) |
| This is a static utility function that will return multiple instances of c_comdef_meeting, based upon the IDs of the meetings. It will create an array to hold these instances. | |
Protected Attributes | |
| $_formats = null | |
| These fields are used to specify the search criteria. | |
| $_service_bodies = null | |
| $_languages = null | |
| $_weekdays = null | |
| $_start_after = null | |
| These specify the start time and duration of the meeting. The start time can be specified as a "window.". | |
| $_start_before = null | |
| An epoch time (seconds, as returned by time()), that denotes the latest starting time allowed. | |
| $_min_duration = null | |
| The number of seconds a meeting should last as a minimum. | |
| $_max_duration = null | |
| The number of seconds a meeting can last, at most. | |
| $_search_radius = null | |
| These specify the search radius (We store it in kilometers). | |
| $_search_radius_count = null | |
| If this is not null, it needs to be a positive integer, indicating the number of meetings to find automatically. | |
| $_search_center_long = null | |
| If $_search_radius is not null, this needs to be a floating-point number that indicates the longitude, in degrees, of the search center. | |
| $_search_center_lat = null | |
| If $_search_radius is not null, this needs to be a floating-point number that indicates the latitude, in degrees, of the search center. | |
| $_search_string = null | |
| We allow a broad string search that goes through all the text items. In English and Spanish, it uses metaphone, which is a "sounds like" phonetic search. | |
| $_search_string_all_words = false | |
| A Boolean. If this is true, then all of the words in a phrase must be present. | |
| $_search_string_literal = false | |
| A Boolean. If this is true, then the spelling must be literal. | |
| $_meeting_key = null | |
| This allows you to filter out a particular value for a key. | |
| $_meeting_key_value = null | |
| $_meeting_key_match_case = false | |
| $_meeting_key_contains = true | |
| If this is false, then the string must be complete. Default is true (contains). | |
| $_meeting_id_array = null | |
| This contains a list of IDs of individual meetings. If it is set, then all other search parameters are ignored. | |
| $_published_search = 0 | |
| This indicates whether the search should include, exclude, or focus on "published" meetings. | |
| $_sort_search_by_distance = false | |
| If this is true, then the search results may be sorted by distance from the geo center. | |
| $_search_results = null | |
| This contains the search results. | |
Private Attributes | |
| $sort_array = null | |
| This contains an array of strings that represent the sort keys. | |
| $sort_desc = false | |
| This is set to true if the sort is a reverse sort. | |
| $sort_depth = 3 | |
| An integer. This is how far back a staged sort goes. Default is 3. 0 is forever. | |
| $_results_per_page = 0 | |
| This refers to portions of a larger search (pages). | |
| $_pageno = 0 | |
| An integer. The page number represented by this object. If $_results_per_page is 0, this is ignored. | |
| $_my_root = null | |
| If this isn't the root, then this will be a reference to the root. | |
| $_my_server = null | |
| A reference to a c_comdef_server object. This is the server to be used for the search. | |
A class to control the basic common functionality of all meeting searches.
| c_comdef_meeting_search_manager::__construct | ( | $ | in_results_per_page = 0, |
| c_comdef_meeting_search_manager &$ | in_parent = null, |
||
| c_comdef_meetings &$ | in_search_results = null, |
||
| $ | in_pageno = 0 |
||
| ) |
Constructor.
| in_results_per_page | An integer that defines how many results per page you want to see. 0 (default) is all in one page. |
| in_parent | A reference to an existing c_comdef_meeting_search_manager object. |
| in_search_results | A reference to some pre-parsed search results. |
| in_pageno | An integer. The page of the main search this is from. |
| c_comdef_meeting_search_manager::ClearSearch | ( | ) |
Clears the search results, so the next access will redo the search.
| c_comdef_meeting_search_manager::ClearSort | ( | ) |
These are sorting functions.
Simply clears out the sort array, so the search is unsorted.
| c_comdef_meeting_search_manager::DoSearch | ( | ) |
Executes a new search. It will always force a new search.
| static c_comdef_meeting_search_manager::GetAllAvailableSortKeys | ( | ) | [static] |
Returns an array of all possible field keys to be used for sorting.
| & c_comdef_meeting_search_manager::GetAvailableFormats | ( | ) |
Returns a multi-dimensional array of references to c_comdef_format objects.
This returns ALL formats; whether or not they are used in meetings.
This will reference the actual objects controlled by the server.
| & c_comdef_meeting_search_manager::GetAvailableLanguages | ( | ) |
These functions will help the caller to get information from the server. You can use them to build a search form.
Returns an array of language enums and names.
| & c_comdef_meeting_search_manager::GetAvailableServiceBodies | ( | ) |
Returns an array of references to c_comdef_service_body objects.
This returns ALL Service bodies; whether or not they contain meetings.
This will reference the actual objects controlled by the server.
| c_comdef_meeting_search_manager::GetDuration_Max | ( | ) |
Get the Maximum Duration value.
| c_comdef_meeting_search_manager::GetDuration_Min | ( | ) |
Get the Minimum Duration value.
| c_comdef_meeting_search_manager::GetFirstIndexInPage | ( | ) |
Accessor -Get the index (1 - based) of the first meeting in this page.
| & c_comdef_meeting_search_manager::GetFormats | ( | ) |
Accessor -Get a reference to the $_formats field.
Default is 0 for all. If no formats are specified (either 1 or -1), then formats will not be a consideration in the meeting search. If any format is specified as 1, then ONLY meetings with the given format will be considered in the search, and you must explicitly set any other formats you wish found.
| & c_comdef_meeting_search_manager::GetLanguages | ( | ) |
Accessor -Get a reference to the $_languages field.
Default is 0 for all. If no languages are specified (either 1 or -1), then language will not be a consideration in the meeting search. If any language is specified as 1, then ONLY meetings with the given language will be considered in the search, and you must explicitly set any other language you wish found.
| c_comdef_meeting_search_manager::GetLastIndexInPage | ( | ) |
Accessor -Get the index (1 - based) of the last meeting in this page.
| c_comdef_meeting_search_manager::GetLatitude | ( | ) |
Get the latitude.
| c_comdef_meeting_search_manager::GetLongitude | ( | ) |
Get the longitude.
| & c_comdef_meeting_search_manager::GetMeetingIDArray | ( | ) |
Get the current search string.
| static c_comdef_meeting_search_manager::GetMultipleMeetingsByID | ( | $ | in_id_array | ) | [static] |
This is a static utility function that will return multiple instances of c_comdef_meeting, based upon the IDs of the meetings. It will create an array to hold these instances.
NOTE: This is NOT the same as the c_comdef_server::GetMeetingsByID() function, as that function returns an instance of c_comdef_meetings.
| in_id_array | An array of integers. The IDs of the meetings. |
| c_comdef_meeting_search_manager::GetNumberOfPages | ( | ) |
Accessor -Get the page number of this set.
| c_comdef_meeting_search_manager::GetNumberOfResults | ( | ) |
Accessor -Get the total number of meetings found. This gives the TOTAL number found, not just the subset in this page.
| c_comdef_meeting_search_manager::GetNumberOfResultsInThisPage | ( | ) |
Accessor -Get the number of meetings in this page.
| c_comdef_meeting_search_manager::GetPageNo | ( | ) |
Accessor -Get the page number of this set.
| & c_comdef_meeting_search_manager::GetPageOfResults | ( | $ | in_page_no = 1 | ) |
Accessor -Get the number of meetings in this page.
This system allows each page to be treated independently, like allowing different sorts without re-sorting the entire search.
This object needs to be the "root" object to return a page.
| in_page_no | A positive integer. This should be 1 to $this->GetNumberOfPages() (1-based) |
| c_comdef_meeting_search_manager::GetPublished | ( | ) |
Get the search for published value.
| c_comdef_meeting_search_manager::GetRadius | ( | $ | in_miles = false | ) |
Get the search radius.
| in_miles | A boolean. If true, the returned value will be in miles. Otherwise, it is returned in kilometers. |
| c_comdef_meeting_search_manager::GetResultsPerPage | ( | ) |
Accessor -Get the number of results per page.
| & c_comdef_meeting_search_manager::GetRootObject | ( | ) |
Accessor -Get a reference to the root object.
| & c_comdef_meeting_search_manager::GetSearchResults_Obj | ( | $ | in_new_search = false | ) |
Returns a reference to the c_comdef_meetings object that contains the results of the search. If this is null, or if the $in_new_search parameter is set to true, the search will be executed, otherwise, this just returns a reference to the existing search results.
| in_new_search | If this is set to true, the search is done anew. |
| & c_comdef_meeting_search_manager::GetSearchResultsAsArray | ( | ) |
This will return the search results as an array of c_comdef_meeting objects.
| & c_comdef_meeting_search_manager::GetSearchString | ( | ) |
Get the current search string.
| & c_comdef_meeting_search_manager::GetServer | ( | ) |
Accessor -Get a reference to the c_comdef_server object.
| & c_comdef_meeting_search_manager::GetServiceBodies | ( | ) |
Accessor -Get a reference to the $_service_bodies field.
Default is 0 for all. If no Service Bodies are specified (either 1 or -1), then Service Bodies will not be a consideration in the meeting search. If any Service Body is specified as 1, then ONLY meetings with the given Service Body will be considered in the search, and you must explicitly set any other Service Bodies you wish found.
| static c_comdef_meeting_search_manager::GetSingleMeetingByID | ( | $ | in_id | ) | [static] |
These are static functions for directly accessing meetings via ID.
This is a static utility function that will return one single instance of c_comdef_meeting, based upon the ID of that meeting.
| in_id | An integer. The ID of the meeting. |
| c_comdef_meeting_search_manager::GetSpecificSortKeys | ( | ) |
These functions deal with the search itself.
Returns an array of field keys to be used for sorting. This function is not static, and searches the found set for keys. As a result, it takes longer.
As a result, this will return null until after a search has been performed.
| c_comdef_meeting_search_manager::GetSquareForRadius | ( | $ | in_weekday_tinyint_array | ) |
These are various utility functions.
This is an internal utility function that takes a specified radius and center point and calculates a square, in longitude and latitude points, that encompasses that radius. This greatly narrows the scope of the search, so the radius calculation will simply eliminate any meetings that are "in the corners."
If the setting is for auto-radius, the auto-radius is first resolved, then the main radius value is set. Remember that auto-radius is for all meetings, all days of the week. It is really a "density test," as opposed to an accurate selector.
| in_weekday_tinyint_array | An array of weekdays in which to filter for. |
| c_comdef_meeting_search_manager::GetStartTime_Max | ( | ) |
Get the "starts before" value.
| c_comdef_meeting_search_manager::GetStartTime_Min | ( | ) |
Get the "starts after" value.
| & c_comdef_meeting_search_manager::GetWeekdays | ( | ) |
Accessor -Get a reference to the $_weekdays field.
Default is 0 for all. If no weekdays are specified (either 1 or -1), then the weekday will not be a consideration in the meeting search. If any weekday is specified as 1, then ONLY meetings that occur on the given weekday will be considered in the search, and you must explicitly set any other weekday you wish found.
| c_comdef_meeting_search_manager::SetDuration | ( | $ | in_max_duration, |
| $ | in_min_duration = null |
||
| ) |
Set a duration time window.
| in_max_duration | An epoch time, defining the maximum duration of a meeting. |
| in_min_duration | If defined, the minimum duration of the meeting. |
| c_comdef_meeting_search_manager::SetFormats | ( | ) |
Sets an internal array of integers, containing the Shared IDs for all available formats on the server. They are initialized to 0 (neutral).
| c_comdef_meeting_search_manager::SetKeyValueSearch | ( | $ | in_meeting_key, |
| $ | in_meeting_key_value, | ||
| $ | in_meeting_key_match_case = false, |
||
| $ | in_meeting_key_contains = true |
||
| ) |
Sets a key/value search.
| in_meeting_key | A string. This is the xact name of the key to match. |
| in_meeting_key_value | A string. The value to match. |
| in_meeting_key_match_case | If true, the case must match. Default is false. |
| in_meeting_key_contains | If this is false, then the string must be complete. Default is true (contains). |
| c_comdef_meeting_search_manager::SetLanguages | ( | ) |
Sets up an internal array of languages. The array uses the language enum as the key, and the -1->0->1 form as the selector.
| c_comdef_meeting_search_manager::SetMeetingIDArray | ( | $ | in_meeting_id_array | ) |
Set the current search string.
| in_meeting_id_array | An array of positive integers. These are the IDs of individual meetings to find. |
| c_comdef_meeting_search_manager::SetPublished | ( | $ | in_published_search | ) |
Sets the search for published value.
| in_published_search | The value to set. It can be:
|
| c_comdef_meeting_search_manager::SetResultsPerPage | ( | $ | in_results_per_page | ) |
Accessor -Set the number of results per page. This will only work on the root object.
| in_results_per_page | A positive integer. If it is 0, then all results will be returned in one page. |
| c_comdef_meeting_search_manager::SetSearchRadiusAndCenterAuto | ( | $ | in_search_result_count, |
| $ | in_long_in_degrees, | ||
| $ | in_lat_in_degrees | ||
| ) |
Set a search center, and a count for an auto radius hunt. The way this works is that the center is set, and the optimal radius is selected in kilometers to deliver that many meetings. The radius starts at 25 Km (about 10 miles), and goes up or down in 5Km "clicks." Under 5Km, it reduces to 0.5Km "clicks." It will not go out more than 100Km.
When it passes the threshold for the number of meetings in the square, the radius is selected, and the _search_radius is set to the number of Kilometers.
We are not looking for an exact meeting count. It should select the first radius that contains AT LEAST the number of meetings requested.
If not enough meetings are found, the radius ends up at 0.
| in_search_result_count | A positive integer. It specifies the number of meetings to find. |
| in_long_in_degrees | The longitude needs to be specified in degrees. |
| in_lat_in_degrees | The latitude needs to be specified in degrees. |
| c_comdef_meeting_search_manager::SetSearchRadiusAndCenterInKm | ( | $ | in_search_radius_in_km, |
| $ | in_long_in_degrees, | ||
| $ | in_lat_in_degrees | ||
| ) |
Set a search radius and center, with the radius in Km.
| in_search_radius_in_km | The radius needs to be specified in kilometers, not miles. |
| in_long_in_degrees | The longitude needs to be specified in degrees. |
| in_lat_in_degrees | The latitude needs to be specified in degrees. |
| c_comdef_meeting_search_manager::SetSearchRadiusAndCenterInMiles | ( | $ | in_search_radius_in_miles, |
| $ | in_long_in_degrees, | ||
| $ | in_lat_in_degrees | ||
| ) |
Set a search radius and center, with the Radius in miles.
| in_search_radius_in_miles | The radius as specified in miles, not Km. |
| in_long_in_degrees | The longitude needs to be specified in degrees. |
| in_lat_in_degrees | The latitude needs to be specified in degrees. |
| c_comdef_meeting_search_manager::SetSearchString | ( | $ | in_search_string, |
| $ | in_all_words = false, |
||
| $ | in_literal = false |
||
| ) |
Set a search string.
| in_search_string | A string. This is a string for which to search. |
| in_all_words | A Boolean. If this is true, then all of the words in a phrase must be present. |
| in_literal | A Boolean. If this is true, then the spelling must be literal. |
| c_comdef_meeting_search_manager::SetServiceBodies | ( | ) |
Sets an internal array of integers, containing the IDs for all available service bodies on the server. They are initialized to 0 (neutral).
| c_comdef_meeting_search_manager::SetSort | ( | $ | in_sort_fields_array = null, |
| $ | in_desc = false, |
||
| $ | in_max_sort_keys = 0 |
||
| ) |
Sets up the sort array and direction. This replaces the entire array and direction. If the array is longer than the maximum number of sort keys, only that number of keys are used.
It will reset the sort direction, so you need to explicitly indicate the sort direction if you want it descending, as opposed to ascending.
| in_sort_fields_array | An array of strings. The array will deliniate the sort order, by field name. Array element [0] will be the highest priority, and it will descend from there. If this is not specified, the sort will be cleared. |
| in_desc | If this is set to true, the sort will be highest to lowest. Default is false. |
| in_max_sort_keys | A positive integer, specifying a new maximum sort depth. If it is not specified, the max will not be changed. |
| c_comdef_meeting_search_manager::SetSortByDistance | ( | $ | in_sort_search_by_distance = false | ) |
Sets the sort by distance flag.
| in_sort_search_by_distance | A Boolean. False is default. |
| c_comdef_meeting_search_manager::SetSortDepth | ( | $ | in_new_depth = 0 | ) |
Accessor. Set the maximum number of sorts to maintain. If the current number is more than the new value, then we remove any beyond that.
| in_new_depth | A positive integer. If nothing is provided, we set to endless (0). |
| c_comdef_meeting_search_manager::SetStartTime | ( | $ | in_starts_after, |
| $ | in_starts_before = null |
||
| ) |
Set a start time window.
| in_starts_after | An epoch time, defining when the meeting should start (or after) |
| in_starts_before | If defined, the meeting must start no later than this. |
| c_comdef_meeting_search_manager::SetTopSortPriority | ( | $ | in_new_top_sort_key, |
| $ | in_desc = false |
||
| ) |
Set a new "top" sort priority.
The prior "top" sort priority will be made secondary. If the key was previously "lower" in the sort priority, it is removed from there.
It will trigger a sort after the new key has been established.
This allows a very "natural" type of sorting, where the user goes from one field to another.
This will always reset the sort direction to the given one (or will reset to ascending). We could save the direction with each column, but that is likely to result in a confusing mess. It's a better idea to just apply the same direction to every column.
| in_new_top_sort_key | A string. This should be the database table column name for the new "top" sort key. |
| in_desc | If this is set to true, the sort will be highest to lowest. Default is false. |
| c_comdef_meeting_search_manager::SortMeetingObjects | ( | $ | in_sort_fields_array = null, |
| $ | in_desc = null |
||
| ) |
Sorts the meetings. This will apply a sort, dependent upon the given fields. The given array contains the field names (SQL columns and keys) for the data to be sorted.
If you don't specify any parameters, the ones from the last sort will be used.
| in_sort_fields_array | An array of strings. The array will deliniate the sort order, by field name. Array element [0] will be the highest priority, and it will descend from there. |
| in_desc | If this is set to true, the sort will be highest to lowest. Default is false. |
| c_comdef_meeting_search_manager::StringSearchForAllWords | ( | ) |
Get the current search string "all words" flag.
| c_comdef_meeting_search_manager::StringSearchIsLiteral | ( | ) |
Get the current search string literal flag.
c_comdef_meeting_search_manager::$_formats = null [protected] |
These fields are used to specify the search criteria.
An array of integers. These are formats. The filtering will be an "AND" filtering, so qualified meetings must have all of the given formats. The key is the format's shared ID, and the value will be one of these:
Default is 0 for all. If no formats are specified (either 1 or -1), then formats will not be a consideration in the meeting search. If any format is specified as 1, then ONLY meetings with the given format will be considered in the search, and you must explicitly set any other formats you wish found.
c_comdef_meeting_search_manager::$_languages = null [protected] |
An array of integers. The key is the language enum, and the value is as follows:
Default is 0 for all. If no languages are specified (either 1 or -1), then language will not be a consideration in the meeting search. If any language is specified as 1, then ONLY meetings with the given language will be considered in the search, and you must explicitly set any other language you wish found.
c_comdef_meeting_search_manager::$_max_duration = null [protected] |
The number of seconds a meeting can last, at most.
c_comdef_meeting_search_manager::$_meeting_id_array = null [protected] |
This contains a list of IDs of individual meetings. If it is set, then all other search parameters are ignored.
An array of positive integers. The Ids of meetings to find. If this is set, all other search criteria are ignored.
c_comdef_meeting_search_manager::$_meeting_key = null [protected] |
This allows you to filter out a particular value for a key.
A string. This is the xact name of the key to match. NOTE: As of Version 1.5, this can be an array of strings (it can still be a single string). The array should contain the names of string fields.
c_comdef_meeting_search_manager::$_meeting_key_contains = true [protected] |
If this is false, then the string must be complete. Default is true (contains).
c_comdef_meeting_search_manager::$_meeting_key_match_case = false [protected] |
If true, the case must match. Default is false. NOTE: As of Version 1.5, setting this to TRUE also stops the metaphone search.
c_comdef_meeting_search_manager::$_meeting_key_value = null [protected] |
A string. The value to match. NOTE: As of Version 1.5, this is matched with a metaphone match, as well as the RegEx match.
c_comdef_meeting_search_manager::$_min_duration = null [protected] |
The number of seconds a meeting should last as a minimum.
c_comdef_meeting_search_manager::$_my_root = null [private] |
If this isn't the root, then this will be a reference to the root.
A reference to an instance of c_comdef_meeting_search_manager -The root object.
c_comdef_meeting_search_manager::$_my_server = null [private] |
A reference to a c_comdef_server object. This is the server to be used for the search.
c_comdef_meeting_search_manager::$_pageno = 0 [private] |
An integer. The page number represented by this object. If $_results_per_page is 0, this is ignored.
c_comdef_meeting_search_manager::$_published_search = 0 [protected] |
This indicates whether the search should include, exclude, or focus on "published" meetings.
This only counts if the searcher is a logged-in admin. The value can be:
c_comdef_meeting_search_manager::$_results_per_page = 0 [private] |
This refers to portions of a larger search (pages).
The number of meetings to list per page.
c_comdef_meeting_search_manager::$_search_center_lat = null [protected] |
If $_search_radius is not null, this needs to be a floating-point number that indicates the latitude, in degrees, of the search center.
c_comdef_meeting_search_manager::$_search_center_long = null [protected] |
If $_search_radius is not null, this needs to be a floating-point number that indicates the longitude, in degrees, of the search center.
c_comdef_meeting_search_manager::$_search_radius = null [protected] |
These specify the search radius (We store it in kilometers).
If this is not null, it needs to be a positive, floating-point number, indicating the radius, in Kilometers.
c_comdef_meeting_search_manager::$_search_radius_count = null [protected] |
If this is not null, it needs to be a positive integer, indicating the number of meetings to find automatically.
c_comdef_meeting_search_manager::$_search_results = null [protected] |
This contains the search results.
A c_comdef_meetings object. If this is null, a new search is performed. This contains the entire search results.
c_comdef_meeting_search_manager::$_search_string = null [protected] |
We allow a broad string search that goes through all the text items. In English and Spanish, it uses metaphone, which is a "sounds like" phonetic search.
A string to be located from within the results. This search is done after all of the previous ones. This is applied at the end.
c_comdef_meeting_search_manager::$_search_string_all_words = false [protected] |
A Boolean. If this is true, then all of the words in a phrase must be present.
c_comdef_meeting_search_manager::$_search_string_literal = false [protected] |
A Boolean. If this is true, then the spelling must be literal.
c_comdef_meeting_search_manager::$_service_bodies = null [protected] |
An array of integers. The key is the ID for a Service Body, and the value is one of these:
Default is 0 for all. If no Service Bodies are specified (either 1 or -1), then Service Bodies will not be a consideration in the meeting search. If any Service Body is specified as 1, then ONLY meetings with the given Service Body will be considered in the search, and you must explicitly set any other Service Bodies you wish found.
c_comdef_meeting_search_manager::$_sort_search_by_distance = false [protected] |
If this is true, then the search results may be sorted by distance from the geo center.
c_comdef_meeting_search_manager::$_start_after = null [protected] |
These specify the start time and duration of the meeting. The start time can be specified as a "window.".
An epoch time (seconds, as returned by time()), that denotes the earliest starting time allowed.
c_comdef_meeting_search_manager::$_start_before = null [protected] |
An epoch time (seconds, as returned by time()), that denotes the latest starting time allowed.
c_comdef_meeting_search_manager::$_weekdays = null [protected] |
An array of integers. The key is the weekday (1 = Sunday, 7 = Saturday), and the value is as follows:
Default is 0 for all. If no weekdays are specified (either 1 or -1), then the weekday will not be a consideration in the meeting search. If any weekday is specified as 1, then ONLY meetings that occur on the given weekday will be considered in the search, and you must explicitly set any other weekday you wish found.
c_comdef_meeting_search_manager::$sort_array = null [private] |
This contains an array of strings that represent the sort keys.
c_comdef_meeting_search_manager::$sort_depth = 3 [private] |
An integer. This is how far back a staged sort goes. Default is 3. 0 is forever.
c_comdef_meeting_search_manager::$sort_desc = false [private] |
This is set to true if the sort is a reverse sort.
1.7.4
