Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] \Pimcore\File::getValidFilename or \Pimcore\Model\Element::getValidKey... maybe some clarification in documentation ? #5152

Open
Yivan opened this issue Oct 25, 2019 · 0 comments

Comments

@Yivan
Copy link
Contributor

@Yivan Yivan commented Oct 25, 2019

Hello,

It seems API Doc for object is no more up to date concerning key validation.
On this page https://pimcore.com/docs/6.x/Development_Documentation/Objects/Working_with_PHP_API.html, exemples use Pimcore\File::getValidFilename.
But this one exists : Pimcore\Model\Element::getValidKey and seems more appropriates ? This one is never mentionned in the documention.

Maybe those two method and their use need to be clarified ?
And the risk/advantage about using it or not maybe.

I am not enough expert on those two method to update directly the documentation, sorry.

Best regards.

@Yivan Yivan changed the title [Doc] \Pimcore\File::getValidFilename or \Pimcore\Model\Element::getValidKey... maby some clarification in documentation ? [Doc] \Pimcore\File::getValidFilename or \Pimcore\Model\Element::getValidKey... maybe some clarification in documentation ? Oct 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.