View Issue Details
ID | Project | Category | View Status | Date Submitted | Last Update |
---|---|---|---|---|---|
12368 | Bug reports | RemoteControl | public | 2017-05-02 12:09 | 2017-06-12 17:17 |
Reporter | tammo | Assigned To | DenisChenu | ||
Priority | none | Severity | partial_block | ||
Status | closed | Resolution | fixed | ||
Product Version | 2.64.x | ||||
Fixed in Version | 2.64.x | ||||
Summary | 12368: Remote control: properties that are available are not shown | ||||
Description | When I want to obtain properties via the RPC, I have to guess the names. For example: when I want to use get_survey_properties, I need to specify the names of the properties that I want to have returned. But I do not know the names of the properties. In a previous version of the RPC wikipage (available until september 25, 2015) there was much more information about the properties, but according to @DenisChenu, they were outdated, so he deleted them. But now we have nothing. Current RPC wikipage: https://manual.limesurvey.org/RemoteControl_2_API How to proceed? | ||||
Tags | No tags attached. | ||||
Bug heat | 8 | ||||
Complete LimeSurvey version number (& build) | 2.64 Irrelevant | ||||
I will donate to the project if issue is resolved | No | ||||
Browser | ff | ||||
Database type & version | ff | ||||
Server OS (if known) | ff | ||||
Webserver software & version (if known) | ff | ||||
PHP Version | ff | ||||
I propose to undelete the deleted parts and search for time/funding/ways to improve this. Either here (wikipage) or at another well-defined place: RPC-API autodoc? |
|
Dennis, just deleting the information was a bad decision. Can you transfer the missing documentation to the source code, please? |
|
Maybe I can help here: I have some ideas about the readability of the doc pages. For example (nearly) all headings at: Proposal for change: and "RPC routine to to initialise the survey's collection of tokens where new participant tokens may be later added." At least some format, where the main object that you work on is mentioned first. I am prepared to work on this. If you tell me where I have to watch out for I will make a pull request for it. Maybe the available properties can be mentioned here to. |
|
PS : in don't find the original issue : but i'm sure we have a discussion about this removing. |
|
See https://github.com/LimeSurvey/LimeSurvey/pull/704 @tammo : i think some settings must be needed, and some other : we can leave it for starting. Did you have a list where the actual information didn't allow a dev to use it ? |
|
PS : about get_survey_properties: it's included in \Survey model then we can only show a @see \Survey because if we update \Survey : we surely didn't update remote_control file ..... |
|
See : https://github.com/LimeSurvey/LimeSurvey/pull/704/commits/c3f1a233b04703cd357188d5b15ee1503f773e7e you don't know property name ? Get them whole. It's the best solution for dev here .... |
|
@tammo and @c_schmitz : see https://limesurvey.sondages.pro/admin/remotecontrol with collapse. Seems better no ? |
|
I think that what Dennis shows in the link to https://limesurvey.sondages.pro/admin/remotecontrol is a great advancement. This would be a great starting point for further development, perhaps with also showing some examples. There are still some speling mistakes, but that can easily be corrected. |
|
@DenisChenu: you stated: "you don't know property name ? Get them whole. It's the best solution for dev here .... " I am not really sure what you mean here. |
|
@DenisChenu: you don't know property name ? Get them whole. It's the best solution for dev here .... If you meant to say: "get them all", I agree fully. I think that when you do not know specifics, it would be great to ask for "all", maybe even by default. Like in token attributes, survey properties, languages atc. |
|
Get them all : before I make same for get_participant_properties, get_question_properties, get_group_properties and get_language_properties. Please see updated https://limesurvey.sondages.pro/admin/remotecontrol documentation with https://github.com/LimeSurvey/LimeSurvey/pull/704 |
|
hero! |
|
@tammo, thanks. i make some test this morning if it's OK and merge it. |
|
Fix committed to master branch: http://bugs.limesurvey.org/plugin.php?page=Source/view&id=22881 |
|
@tammo : if you can fix speling mistakes please. About improvments , i think we can
|
|
PS : see https://api.limesurvey.org/errors.html#application/models/Survey.php for example |
|
Version 2.65.4 (build 170612) released. |
|
LimeSurvey: master bb6346ec 2017-05-26 08:24:35
Committer: GitHub Details Diff |
Fixed issue 12368: Remote control: properties that are available are not shown New feature : Remote control : allow to get all attributes in get function New feature : add some collapse feature to remotecontrol function list Dev: https://www.phpdoc.org/docs/latest/references/phpdoc/basic-syntax.html allow markdown the use it Dev: get_group_properties, get_language_properties, get_participant_properties, get_question_properties, get_summary, get_survey_properties |
Affected Issues 12368 |
|
mod - application/controllers/admin/remotecontrol.php | Diff File | ||
mod - application/helpers/remotecontrol/remotecontrol_handle.php | Diff File | ||
mod - application/views/admin/remotecontrol/index_view.php | Diff File | ||
LimeSurvey: master 966b3de9 2017-05-26 10:04:05 Committer: |
Dev: corrected comment spelling in issue 12368 |
Affected Issues 12368 |
|
mod - application/helpers/remotecontrol/remotecontrol_handle.php | Diff File |
Date Modified | Username | Field | Change |
---|---|---|---|
2017-05-02 12:09 | tammo | New Issue | |
2017-05-02 16:22 | tammo | Note Added: 43525 | |
2017-05-05 17:10 | c_schmitz | Assigned To | => DenisChenu |
2017-05-05 17:10 | c_schmitz | Status | new => assigned |
2017-05-05 17:12 | c_schmitz | Note Added: 43575 | |
2017-05-05 17:21 | tammo | Note Added: 43576 | |
2017-05-05 17:22 | tammo | Note Edited: 43576 | |
2017-05-05 17:52 | DenisChenu | Note Added: 43577 | |
2017-05-24 16:20 | DenisChenu | Note Added: 43709 | |
2017-05-24 16:22 | DenisChenu | Note Added: 43710 | |
2017-05-24 17:29 | DenisChenu | Note Added: 43711 | |
2017-05-24 17:53 | DenisChenu | Note Added: 43712 | |
2017-05-25 16:50 | tammo | Note Added: 43715 | |
2017-05-25 18:33 | tammo | Note Added: 43716 | |
2017-05-25 18:57 | tammo | Note Added: 43717 | |
2017-05-25 21:24 | DenisChenu | Note Added: 43718 | |
2017-05-25 22:20 | tammo | Note Added: 43719 | |
2017-05-26 08:05 | DenisChenu | Note Added: 43720 | |
2017-05-26 08:24 |
|
Changeset attached | => LimeSurvey master bb6346ec |
2017-05-26 08:24 |
|
Note Added: 43721 | |
2017-05-26 08:24 |
|
Assigned To | DenisChenu => user70560 |
2017-05-26 08:24 |
|
Resolution | open => fixed |
2017-05-26 08:35 | DenisChenu | Assigned To | user70560 => DenisChenu |
2017-05-26 08:35 | DenisChenu | Status | assigned => resolved |
2017-05-26 08:35 | DenisChenu | Fixed in Version | => 2.64.x |
2017-05-26 08:35 | DenisChenu | Note Added: 43722 | |
2017-05-26 08:38 | DenisChenu | Note Added: 43723 | |
2017-05-26 10:04 |
|
Changeset attached | => LimeSurvey master 966b3de9 |
2017-06-12 17:17 | c_schmitz | Note Added: 43882 | |
2017-06-12 17:17 | c_schmitz | Status | resolved => closed |