Services_Atlassian_Crowd
[ class tree: Services_Atlassian_Crowd ] [ index: Services_Atlassian_Crowd ] [ all elements ]
Packages:
Services_Atlassian_Crowd


Classes:
Services_Atlassian_Crowd
Services_Atlassian_Crowd_Exception
Files:
Crowd.php
Exception.php

Class: Services_Atlassian_Crowd

Source Location: /Services_Atlassian_Crowd-0.9.5/Crowd.php

Class Overview




Class to use Crowd API from PHP




Author(s):






              
                      


Copyright:


    
  
  • 2008 Infinite Campus Inc., 2008 Luca Corbo
    • 







Variables






Methods
















Inherited Variables





Inherited Methods














Class Details



[line 60]

Class to use Crowd API from PHP









[ Top ]







Class Variables



	
	

	
$crowd_app_token = 

	
[line 82]

  The Crowd application token


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$crowd_client = 

	
[line 68]

  The Crowd SOAP client


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      object
    

      

	



	
[ Top ]


	
	

	
$crowd_config = 

	
[line 75]

  Array contains the configuration parameters


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Method Detail



	
	
__construct (Constructor)   [line 111]

	

    

    

		Services_Atlassian_Crowd __construct(
array
$options)
    

    


	
		Create an application client using the passed in configuration parameters.
Available options are:
  • string  app_name:  The username which the application will use when it
                      authenticates against the Crowd framework as a client.
 
  • string  app_credential: The password which the application will use when it
                           authenticates against the Crowd framework
                           as a client.
 
  • string  service_url: The SOAP WSDL URL for Crowd


    

  • Throws: Services_Atlassian_Crowd_Exception if there is an error communicating                                             with the Crowd security server.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $options  
        — 
        optional. An array of options used to connect to Crowd.
      

        

    


        
[ Top ]

  

  
  
	
	
authenticateApplication   [line 142]

	

    

    

		string authenticateApplication(
)
    

    


	
		Authenticates an application client to the Crowd security server.


    

  • Return: the application token
    • 

  • Throws: Services_Atlassian_Crowd_Exception if there is an error communicating                                             with the Crowd security server.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
authenticatePrincipal   [line 181]

	

    

    

		string authenticatePrincipal(
string
$name, string
$credential, string
$user_agent, string
$remote_address)
    

    


	
		Authenticates a principal to the Crowd security server  for the application client.


    

  • Return: the principal token
    • 

  • Throws: Services_Atlassian_Crowd_Exception if there is an error communicating                                             with the Crowd security server.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $name  
        — 
        The username to authenticate
      

          

        string  
        $credential  
        — 
        The password of the user to authenticate
      

          

        string  
        $user_agent  
        — 
        The user agent
      

          

        string  
        $remote_address  
        — 
        The remote address
      

        

    


        
[ Top ]

  

  
  
	
	
__call   [line 228]

	

    

    

		object | __call(
string
$method, mixed
$args)
    

    


	
		Calls a remote method


    

  • Return: true
    • 

  • Method: object isValidPrincipalToken(array($princ_token, $user_agent,: $remote_address))                     Determines if the principal's current token is still valid in Crowd.
    • 

  • Method: object findPrincipalByToken(string $princ_token): Finds a principal by token.
    • 

  • Method: object findGroupMemberships(string $princ_name): Finds all of the groups the specified principal is in.
    • 

  • Throws: Services_Atlassian_Crowd_Exception if there is an error communicating                                             with the Crowd security server.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $method  
        — 
        The remote method to call
      

          

        mixed  
        $args  
        — 
        The parameters to use with remote method
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 15:28:57 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.