PHP 클래스 Shanty_Mongo

저자: Coen Hyde
파일 보기 프로젝트 열기: coen-hyde/shanty-mongo 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$_connectionGroups
$_initialised
$_requirementCreators
$_requirements
$_validOperations

공개 메소드들

메소드 설명
addConnections ( array $options ) Add connections Shanty Mongo
addMaster ( Shanty_Mongo_Connection $connection, integer $weight = 1, $connectionGroup = 'default' ) Add a connection to a master server
addSlave ( Shanty_Mongo_Connection $connection, $weight = 1, $connectionGroup = 'default' ) Add a connection to a slaver server
createRequirement ( $name, $options = null ) : mixed Create a requirement
getConnectionGroup ( string $name ) : Shanty_Mongo_Connection_Group Get a connection group. If it doesn't already exist, create it
getConnectionGroups ( ) : array Get a list of all connection groups
getReadConnection ( string $connectionGroupName = 'default' ) : Shanty_Mongo_Connection Get a read connection
getWriteConnection ( string $connectionGroupName = 'default' ) : Shanty_Mongo_Connection Get a write connection
hasConnectionGroup ( string $name ) Determine if a connection group exists
init ( ) Initialise Shanty_Mongo. In particular all the requirements.
isValidOperation ( string $operation ) Deterimine if an operation is valid
makeClean ( ) Return Shanty_Mongo to pre-init status
removeConnectionGroups ( ) Remove all connection groups
removeRequirementCreators ( ) Remove all requirement creators
removeRequirements ( ) Remove all requirements
retrieveRequirement ( $name, $options = null ) : mixed Get the requirement matching the name provided
setConnectionGroup ( string $name, Shanty_Mongo_Connection_Group $connectionGroup ) Set a connection group
storeRequirement ( $name, $requirement ) Add requirements to use in validation of document properties
storeRequirementCreator ( $regex, Closure $function ) Add a creator of requirements

메소드 상세

addConnections() 공개 정적인 메소드

Add connections Shanty Mongo
public static addConnections ( array $options )
$options array

addMaster() 공개 정적인 메소드

Add a connection to a master server
public static addMaster ( Shanty_Mongo_Connection $connection, integer $weight = 1, $connectionGroup = 'default' )
$connection Shanty_Mongo_Connection
$weight integer

addSlave() 공개 정적인 메소드

Add a connection to a slaver server
public static addSlave ( Shanty_Mongo_Connection $connection, $weight = 1, $connectionGroup = 'default' )
$connection Shanty_Mongo_Connection
$weight

createRequirement() 공개 정적인 메소드

Create a requirement
public static createRequirement ( $name, $options = null ) : mixed
$name String Name of requirement
리턴 mixed

getConnectionGroup() 공개 정적인 메소드

Get a connection group. If it doesn't already exist, create it
public static getConnectionGroup ( string $name ) : Shanty_Mongo_Connection_Group
$name string The name of the connection group
리턴 Shanty_Mongo_Connection_Group

getConnectionGroups() 공개 정적인 메소드

Get a list of all connection groups
public static getConnectionGroups ( ) : array
리턴 array

getReadConnection() 공개 정적인 메소드

Get a read connection
public static getReadConnection ( string $connectionGroupName = 'default' ) : Shanty_Mongo_Connection
$connectionGroupName string The connection group name
리턴 Shanty_Mongo_Connection

getWriteConnection() 공개 정적인 메소드

Get a write connection
public static getWriteConnection ( string $connectionGroupName = 'default' ) : Shanty_Mongo_Connection
$connectionGroupName string The connection group name
리턴 Shanty_Mongo_Connection

hasConnectionGroup() 공개 정적인 메소드

Determine if a connection group exists
public static hasConnectionGroup ( string $name )
$name string The name of the connection group

init() 공개 정적인 메소드

Initialise Shanty_Mongo. In particular all the requirements.
public static init ( )

isValidOperation() 공개 정적인 메소드

Deterimine if an operation is valid
public static isValidOperation ( string $operation )
$operation string

makeClean() 공개 정적인 메소드

Return Shanty_Mongo to pre-init status
public static makeClean ( )

removeConnectionGroups() 공개 정적인 메소드

Remove all connection groups
public static removeConnectionGroups ( )

removeRequirementCreators() 공개 정적인 메소드

Remove all requirement creators
public static removeRequirementCreators ( )

removeRequirements() 공개 정적인 메소드

Remove all requirements
public static removeRequirements ( )

retrieveRequirement() 공개 정적인 메소드

Get the requirement matching the name provided
public static retrieveRequirement ( $name, $options = null ) : mixed
$name String Name of requirement
리턴 mixed

setConnectionGroup() 공개 정적인 메소드

Set a connection group
public static setConnectionGroup ( string $name, Shanty_Mongo_Connection_Group $connectionGroup )
$name string
$connectionGroup Shanty_Mongo_Connection_Group

storeRequirement() 공개 정적인 메소드

Add requirements to use in validation of document properties
public static storeRequirement ( $name, $requirement )
$name String Name of requirement
$requirement mixed

storeRequirementCreator() 공개 정적인 메소드

Add a creator of requirements
public static storeRequirementCreator ( $regex, Closure $function )
$function Closure

프로퍼티 상세

$_connectionGroups 보호되어 있는 정적으로 프로퍼티

protected static $_connectionGroups

$_initialised 보호되어 있는 정적으로 프로퍼티

protected static $_initialised

$_requirementCreators 보호되어 있는 정적으로 프로퍼티

protected static $_requirementCreators

$_requirements 보호되어 있는 정적으로 프로퍼티

protected static $_requirements

$_validOperations 보호되어 있는 정적으로 프로퍼티

protected static $_validOperations