Apache Zeta Components Manual :: File Source for ldap_exception.php

Source for file ldap_exception.php

Documentation is available at ldap_exception.php

  1. <?php
  2. /**
  3.  * File containing the ezcAuthenticationLdapException class.
  4.  *
  5.  * Licensed to the Apache Software Foundation (ASF) under one
  6.  * or more contributor license agreements.  See the NOTICE file
  7.  * distributed with this work for additional information
  8.  * regarding copyright ownership.  The ASF licenses this file
  9.  * to you under the Apache License, Version 2.0 (the
  10.  * "License"); you may not use this file except in compliance
  11.  * with the License.  You may obtain a copy of the License at
  12.  * 
  13.  *   http://www.apache.org/licenses/LICENSE-2.0
  14.  * 
  15.  * Unless required by applicable law or agreed to in writing,
  16.  * software distributed under the License is distributed on an
  17.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  18.  * KIND, either express or implied.  See the License for the
  19.  * specific language governing permissions and limitations
  20.  * under the License.
  21.  *
  22.  * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
  23.  * @filesource
  24.  * @package Authentication
  25.  * @version //autogen//
  26.  */
  27.  
  28. /**
  29.  * Thrown when an exceptional state occurs in the LDAP authentication.
  30.  *
  31.  * @package Authentication
  32.  * @version //autogen//
  33.  */
  34. {
  35.     /**
  36.      * Constructs a new ezcAuthenticationLdapException with error message
  37.      * $message and error code $code.
  38.      *
  39.      * Code $code is received in decimal format and will be displayed in
  40.      * hexadecimal format. See http://php.net/manual/en/function.ldap-errno.php
  41.      * for all the error codes returned by ldap_errno().
  42.      *
  43.      * @param string $message Message to throw
  44.      * @param mixed $code Error code returned by ldap_errno() function
  45.      * @param mixed $ldapMessage Message thrown by the LDAP server
  46.      */
  47.     public function __construct$message$code false$ldapMessage false )
  48.     {
  49.         $exMessage $message;
  50.         if $ldapMessage !== false )
  51.         {
  52.             $exMessage .= ': ' $ldapMessage;
  53.         }
  54.         if $code !== false )
  55.         {
  56.             $exMessage .= ' (code: ' $code ')';
  57.         }
  58.         parent::__construct$exMessage );
  59.     }
  60. }
  61. ?>
Documentation generated by phpDocumentor 1.4.3