Comments (6)
Hmm. I haven't thought of this yet. Glad you raised the issue here at least for discussion. It sounds like it might be a wise idea. My only concern would be how do we warn users of the library of the change in behavior? I assume a change like this would require the user of the library to adjust their code to release the key is now the int id and not project name. Where else did you see this issue? It wasn't too clear to me from the post. Thanks for reporting it.
from php-redmine-api.
Oh! That's a good point indeed. Although as it really happen to you before that you named 2 Versions or Projects the same way?
I'm not trying to argue your point, if the name is not unique then this indeed is a bug!
@wsuff : how about renaming the listing method "listingById()" and correcting all the listing() method with the changes proposed by @Eighke ? The change would then be almost transparent to anybody using the listing(). This is not a stable version anyway, so i would say this BC breaks are ok at such an early stage.
What do you think?
from php-redmine-api.
@kbsali yes I have some sub Projects with the same name. Something like :
- Project 1
- Frontend
- Backend
- Project 2
- Backend
- Engine
@wsuff , well good question. I checked, only Version and Project is affected. In the other class the name is unique. listingById() isn't a bad idea or maybe something like :
public function listing($project, $forceUpdate = false, $reverse = true)
{
if (true === $forceUpdate || empty($this->versions)) {
$this->all($project);
}
$ret = array();
foreach ($this->versions['versions'] as $e) {
$ret[$e[(int) 'id']] = $e['name'];
}
return $reverse ? array_flip($ret) : $ret;
}
Dunno which one is the best option.
from php-redmine-api.
Ah. It makes more sense now. This wasn't a case I've noticed on my own install of Redmine yet since getting people to use a system after having none has been enough of challenge. =) listById() sounds ok to me. I can't really see any major downside to either proposed solution tho. Perhaps just a matter of preference and keeping consistence in the library.
Just realized this project is only month 1/2 old or so. Guess I lucked out that it was available when I went looking for one.
from php-redmine-api.
@Eighke thanks for pointing out this solution,
i've implemented it for Version and Project as you mentioned these were the 2 affected classes!
Please review the changes and close if ok.
from php-redmine-api.
Tested and approved. :)
Thanks.
from php-redmine-api.
Related Issues (20)
- Do not use temporary cache in `Redmine\Api\...::list()` methods
- [Idea] New CommandClient (High-level API), split Client and Configuration
- Rename `Response::getBody()` to `Response::getContent()`
- Add method `UnexpectedResponseException::getResponse()`
- Check Status Code of responses (especially for POST/PUT/DELETE requests)
- Create factory methods in all API classes
- Declare all `Redmine\Api\...` classes as final
- Deprecate `AbstractApi::get()`, `AbstractApi::post()`, `AbstractApi::put()` and `AbstractApi::delete()`
- Wiki page title must be urlencoded
- Third party package support: Could not create XML from array HOT 3
- Fix @deprecated phpdoc syntax
- Deprecate all `\Redmine\Api\Issue::PRIO_*` constants
- Remove `\Redmine\Api\Issue::PRIO_*` constants
- Update to Redmine 5.0.8 and 5.1.2 in tests HOT 1
- Deprecate `getLastResponseStatusCode`, `getLastResponseContentType` and `getLastResponseBody` in Clients
- author_id Params Not Working When Creating New Issue HOT 1
- XML/JSON parameter mismatch in TimeEntry.php HOT 9
- Remove `Redmine\Api\...::listing()` methods
- Deprecate all `Redmine\Api\*::getIdByName()` methods
- Remove all `Redmine\Api\*::getIdByName()` methods
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from php-redmine-api.