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

Source for file id_credentials.php

Documentation is available at id_credentials.php

  1. <?php
  2. /**
  3.  * File containing the ezcAuthenticationIdCredentials structure.
  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.  * Structure containing an id, used as authentication credentials.
  30.  *
  31.  * @package Authentication
  32.  * @version //autogen//
  33.  * @mainclass
  34.  */
  35. {
  36.     /**
  37.      * Username or userID or url.
  38.      *
  39.      * @var string 
  40.      */
  41.     public $id;
  42.  
  43.     /**
  44.      * Constructs a new ezcAuthenticationIdCredentials object.
  45.      *
  46.      * @param string $id 
  47.      */
  48.     public function __construct$id )
  49.     {
  50.         $this->id = $id;
  51.     }
  52.  
  53.     /**
  54.      * Returns a new instance of this class with the data specified by $array.
  55.      *
  56.      * $array contains all the data members of this class in the form:
  57.      * array('member_name'=>value).
  58.      *
  59.      * __set_state makes this class exportable with var_export.
  60.      * var_export() generates code, that calls this method when it
  61.      * is parsed with PHP.
  62.      *
  63.      * @param array(string=>mixed) $array Associative array of data members for this class
  64.      * @return ezcAuthenticationIdCredentials 
  65.      */
  66.     public static function __set_statearray $array )
  67.     {
  68.         return new ezcAuthenticationIdCredentials$array['id');
  69.     }
  70.  
  71.     /**
  72.      * Returns string representation of the credentials.
  73.      *
  74.      * Use it to save the credentials in the session.
  75.      * 
  76.      * @return string 
  77.      */
  78.     public function __toString()
  79.     {
  80.         return $this->id;
  81.     }
  82. }
  83. ?>
Documentation generated by phpDocumentor 1.4.3