Skip to content

[Ldap] Updated Ldap component documentation for 3.1 #6982

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

Closed
wants to merge 2 commits into from
Closed

[Ldap] Updated Ldap component documentation for 3.1 #6982

wants to merge 2 commits into from

Conversation

csarrazi
Copy link
Contributor

Q A
Doc fix? no
New docs? yes
Applies to 3.1, 3.2
Fixed tickets #5756

Unfortunately, I didn't have the time to update the docs since I have been pretty busy these last months, but like people say, better late than never!
The documentation has been updated for version 3.1 of the Ldap component, which no longer uses the same class, and now provides an LdapManager which can create new LDAP entries, or manipulate existing ones (update or delete).

I didn't add a documentation section regarding the legacy classes, but I figure that they should no longer be described as the main entry points for the Ldap component.

@mipapo
Copy link

mipapo commented Sep 22, 2016

Just for your own reference:
symfony/symfony#19008 (comment)

Your answer there really helped me!

Copy link
Member

@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 very nice changes as usual. Thanks for updating the docs.


``useStartTls``
Whether or not to secure the connection using StartTLS
``connection_string``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated to this PR, but this option name looks weird. Is there a better alternative to connection_string ? For example, like dsn in the database world.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, the term "DSN" is specific to the database world. "connection_string" is standard for all software, and not only databases. :)

``useStartTls``
Whether or not to secure the connection using StartTLS
``connection_string``
You may use this option instead of
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This phrase looks unfinished: You may use this option instead of

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed! Good catch!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll change that soon (this week or the next, depending on whether I can find time to change this), and also add some information which came from my previous github comments (like @mipapo mentioned).

I'll

@lsmith77
Copy link
Contributor

ping .. right now the 3.1 docs still talk about LdapClient which is deprecated .. would be nice to get this up to date quickly ..

@csarrazi
Copy link
Contributor Author

csarrazi commented Dec 5, 2016

Unfortunately, I won't have time before the end of the week as I am pretty busy currently. Should be fine next week, though! :)

nietonfir pushed a commit to nietonfir/symfony-docs that referenced this pull request Jan 30, 2017
as LdapClient has been marked deprecated in 3.1.

Refs symfony/symfony#19008, symfony#6982
nietonfir pushed a commit to nietonfir/symfony-docs that referenced this pull request Jan 30, 2017
as LdapClient has been marked deprecated in 3.1.

Refs symfony/symfony#19008, symfony#6982
nietonfir pushed a commit to nietonfir/symfony-docs that referenced this pull request Jan 30, 2017
as LdapClient has been marked deprecated in 3.1.

Refs symfony/symfony#19008, symfony#6982
@COil
Copy link
Contributor

COil commented Mar 9, 2017

The doc is still outdated ? I have tested with the Ldad class (+factory) and it works well.

@HeahDude HeahDude added the Ldap label Mar 9, 2017
@csarrazi
Copy link
Contributor Author

Yes, there are a few things still pending to get this PR merged. Unfortunately I am too busy to finalise this in the short term, but if someone wants, he can make a small PR against my fork, or create a new PR based on this one.

@HeahDude HeahDude added this to the 3.2 milestone Jul 29, 2017
@javiereguiluz
Copy link
Member

This has been finally merged! Thanks for contributing these docs.

javiereguiluz added a commit that referenced this pull request Jan 9, 2018
…razi, javiereguiluz)

This PR was submitted for the 3.1 branch but it was merged into the 3.3 branch instead (closes #6982).

Discussion
----------

[Ldap] Updated Ldap component documentation for 3.1

| Q | A |
| --- | --- |
| Doc fix? | no |
| New docs? | yes |
| Applies to | 3.1, 3.2 |
| Fixed tickets | #5756 |

Unfortunately, I didn't have the time to update the docs since I have been pretty busy these last months, but like people say, better late than never!
The documentation has been updated for version 3.1 of the Ldap component, which no longer uses the same class, and now provides an LdapManager which can create new LDAP entries, or manipulate existing ones (update or delete).

I didn't add a documentation section regarding the legacy classes, but I figure that they should no longer be described as the main entry points for the Ldap component.

Commits
-------

066f5be Minor fixes
78ed43d Updated LDAP documentation for Symfony 3.1
@csarrazi
Copy link
Contributor Author

csarrazi commented Jan 9, 2018

Woohoo! Thanks @javiereguiluz!

@xabbuh xabbuh closed this Jan 9, 2018
@csarrazi csarrazi deleted the feat/ldap-3.1 branch January 9, 2018 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants