PHP library that can use different authentication mechanisms












1












$begingroup$


I am making a library which can use different auth mechanisms. I have abstracted the code within an interface:



interface Authenticable
{
public function getName(): string;

/**
* Based on auth type, return the right format of credentials to be sent to the server
*
* @param Authenticable $credentials
* @return mixed
*/
public function encodedCredentials(): string;
}


One of the possible methods to use this is Plain.php:



class Plain implements Authenticable
{
protected $name = 'PLAIN';
protected $options;

public function __construct(Options $options)
{
$this->options = $options;
}

public function encodedCredentials(): string
{
$credentials = "x00{$this->options->getUsername()}x00{$this->options->getPassword()}";
return XML::quote(base64_encode($credentials));
}

public function getName(): string
{
return $this->name;
}
}


And when initializing auth methods I am using this part of code



public function getAuthType()
{
if (!$this->authType)
$this->authType = new Plain($this->options);

return $this->authType;
}


which is initializing Plain if no other method was previously given.



What I am wondering here is: should I forward $username and $password to Plain so that I could decouple it from Options class (since those are the only two fields needed in the class)?



On the other hand, that is what Options class is all about. Besides username and pass, it also holds host, port, logger and resource setters and getters, and few helper methods










share|improve this question









New contributor




Norgul is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.







$endgroup$

















    1












    $begingroup$


    I am making a library which can use different auth mechanisms. I have abstracted the code within an interface:



    interface Authenticable
    {
    public function getName(): string;

    /**
    * Based on auth type, return the right format of credentials to be sent to the server
    *
    * @param Authenticable $credentials
    * @return mixed
    */
    public function encodedCredentials(): string;
    }


    One of the possible methods to use this is Plain.php:



    class Plain implements Authenticable
    {
    protected $name = 'PLAIN';
    protected $options;

    public function __construct(Options $options)
    {
    $this->options = $options;
    }

    public function encodedCredentials(): string
    {
    $credentials = "x00{$this->options->getUsername()}x00{$this->options->getPassword()}";
    return XML::quote(base64_encode($credentials));
    }

    public function getName(): string
    {
    return $this->name;
    }
    }


    And when initializing auth methods I am using this part of code



    public function getAuthType()
    {
    if (!$this->authType)
    $this->authType = new Plain($this->options);

    return $this->authType;
    }


    which is initializing Plain if no other method was previously given.



    What I am wondering here is: should I forward $username and $password to Plain so that I could decouple it from Options class (since those are the only two fields needed in the class)?



    On the other hand, that is what Options class is all about. Besides username and pass, it also holds host, port, logger and resource setters and getters, and few helper methods










    share|improve this question









    New contributor




    Norgul is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
    Check out our Code of Conduct.







    $endgroup$















      1












      1








      1





      $begingroup$


      I am making a library which can use different auth mechanisms. I have abstracted the code within an interface:



      interface Authenticable
      {
      public function getName(): string;

      /**
      * Based on auth type, return the right format of credentials to be sent to the server
      *
      * @param Authenticable $credentials
      * @return mixed
      */
      public function encodedCredentials(): string;
      }


      One of the possible methods to use this is Plain.php:



      class Plain implements Authenticable
      {
      protected $name = 'PLAIN';
      protected $options;

      public function __construct(Options $options)
      {
      $this->options = $options;
      }

      public function encodedCredentials(): string
      {
      $credentials = "x00{$this->options->getUsername()}x00{$this->options->getPassword()}";
      return XML::quote(base64_encode($credentials));
      }

      public function getName(): string
      {
      return $this->name;
      }
      }


      And when initializing auth methods I am using this part of code



      public function getAuthType()
      {
      if (!$this->authType)
      $this->authType = new Plain($this->options);

      return $this->authType;
      }


      which is initializing Plain if no other method was previously given.



      What I am wondering here is: should I forward $username and $password to Plain so that I could decouple it from Options class (since those are the only two fields needed in the class)?



      On the other hand, that is what Options class is all about. Besides username and pass, it also holds host, port, logger and resource setters and getters, and few helper methods










      share|improve this question









      New contributor




      Norgul is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.







      $endgroup$




      I am making a library which can use different auth mechanisms. I have abstracted the code within an interface:



      interface Authenticable
      {
      public function getName(): string;

      /**
      * Based on auth type, return the right format of credentials to be sent to the server
      *
      * @param Authenticable $credentials
      * @return mixed
      */
      public function encodedCredentials(): string;
      }


      One of the possible methods to use this is Plain.php:



      class Plain implements Authenticable
      {
      protected $name = 'PLAIN';
      protected $options;

      public function __construct(Options $options)
      {
      $this->options = $options;
      }

      public function encodedCredentials(): string
      {
      $credentials = "x00{$this->options->getUsername()}x00{$this->options->getPassword()}";
      return XML::quote(base64_encode($credentials));
      }

      public function getName(): string
      {
      return $this->name;
      }
      }


      And when initializing auth methods I am using this part of code



      public function getAuthType()
      {
      if (!$this->authType)
      $this->authType = new Plain($this->options);

      return $this->authType;
      }


      which is initializing Plain if no other method was previously given.



      What I am wondering here is: should I forward $username and $password to Plain so that I could decouple it from Options class (since those are the only two fields needed in the class)?



      On the other hand, that is what Options class is all about. Besides username and pass, it also holds host, port, logger and resource setters and getters, and few helper methods







      php object-oriented authentication library






      share|improve this question









      New contributor




      Norgul is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.











      share|improve this question









      New contributor




      Norgul is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.









      share|improve this question




      share|improve this question








      edited 10 mins ago









      200_success

      130k17155419




      130k17155419






      New contributor




      Norgul is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.









      asked 12 hours ago









      NorgulNorgul

      1062




      1062




      New contributor




      Norgul is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.





      New contributor





      Norgul is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.






      Norgul is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.






















          0






          active

          oldest

          votes











          Your Answer





          StackExchange.ifUsing("editor", function () {
          return StackExchange.using("mathjaxEditing", function () {
          StackExchange.MarkdownEditor.creationCallbacks.add(function (editor, postfix) {
          StackExchange.mathjaxEditing.prepareWmdForMathJax(editor, postfix, [["\$", "\$"]]);
          });
          });
          }, "mathjax-editing");

          StackExchange.ifUsing("editor", function () {
          StackExchange.using("externalEditor", function () {
          StackExchange.using("snippets", function () {
          StackExchange.snippets.init();
          });
          });
          }, "code-snippets");

          StackExchange.ready(function() {
          var channelOptions = {
          tags: "".split(" "),
          id: "196"
          };
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function() {
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled) {
          StackExchange.using("snippets", function() {
          createEditor();
          });
          }
          else {
          createEditor();
          }
          });

          function createEditor() {
          StackExchange.prepareEditor({
          heartbeatType: 'answer',
          autoActivateHeartbeat: false,
          convertImagesToLinks: false,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: null,
          bindNavPrevention: true,
          postfix: "",
          imageUploader: {
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          },
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          });


          }
          });






          Norgul is a new contributor. Be nice, and check out our Code of Conduct.










          draft saved

          draft discarded


















          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f216183%2fphp-library-that-can-use-different-authentication-mechanisms%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown

























          0






          active

          oldest

          votes








          0






          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes








          Norgul is a new contributor. Be nice, and check out our Code of Conduct.










          draft saved

          draft discarded


















          Norgul is a new contributor. Be nice, and check out our Code of Conduct.













          Norgul is a new contributor. Be nice, and check out our Code of Conduct.












          Norgul is a new contributor. Be nice, and check out our Code of Conduct.
















          Thanks for contributing an answer to Code Review Stack Exchange!


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          Use MathJax to format equations. MathJax reference.


          To learn more, see our tips on writing great answers.




          draft saved


          draft discarded














          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f216183%2fphp-library-that-can-use-different-authentication-mechanisms%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          Popular posts from this blog

          Сан-Квентин

          8-я гвардейская общевойсковая армия

          Алькесар