pike.git/lib/modules/Protocols.pmod/LDAP.pmod/client.pike:638: Inside #if undefined(PARSE_RFCS)
//! @decl void create(string|mapping(string:mixed) url, object context)
//!
//! Create object. The first optional argument can be used later
//! for subsequence operations. The second one can specify
//! TLS context of connection. The default context only allows
//! 128-bit encryption methods, so you may need to provide your
//! own context if your LDAP server supports only export encryption.
//!
//! @param url
//! LDAP server URL on the form
- //! @expr{"ldap://hostname/basedn?attrlist?scope?ext"@}. See RFC
- //! 2255. It can also be a mapping as returned by
- //! @[Protocol.LDAP.parse_ldap_url].
+ //! @expr{"ldap://hostname/basedn?attrlist?scope?ext"@}. See @rfc{2255@}.
+ //! It can also be a mapping as returned by @[Protocol.LDAP.parse_ldap_url].
//!
//! @param context
//! TLS context of connection
//!
//! @seealso
//! @[LDAP.client.bind], @[LDAP.client.search]
void create(string|mapping(string:mixed)|void url, object|void context)
{
info = ([ "code_revision" :
pike.git/lib/modules/Protocols.pmod/LDAP.pmod/client.pike:1327:
Integer(timelimit),
Boolean(attrsonly ? -1 : 0),
@ohlp
})) ;
}
//! Search LDAP directory.
//!
//! @param filter
//! Search filter to override the one from the LDAP URL. It's
- //! either a string with the format specified in RFC 2254, or an
+ //! either a string with the format specified in @rfc{2254@}, or an
//! object returned by @[Protocols.LDAP.make_filter].
//!
//! @param attrs
//! The array of attribute names which will be returned by server
//! for every entry.
//!
//! @param attrsonly
//! This flag causes server return only the attribute types (aka
//! names) but not their values. The values will instead be empty
//! arrays or - if @[Protocols.LDAP.SEARCH_MULTIVAL_ARRAYS_ONLY]
pike.git/lib/modules/Protocols.pmod/LDAP.pmod/client.pike:2305:
"dsaoperation": "dSAOperation"
]),
"": "qdstrings"
]);
protected mapping(string:mapping(string:mixed)) attr_type_descrs;
mapping(string:mixed) get_attr_type_descr (string attr, void|int standard_attrs)
//! Returns the attribute type description for the given attribute,
//! which includes the name, object identifier, syntax, etc (see
- //! section 4.2 in RFC 2252 for details).
+ //! @rfc{2252:4.2@} for details).
//!
//! This might do a query to the server, but results are cached.
//!
//! @param attr
//! The name of the attribute. Might also be the object identifier
//! on string form.
//!
//! @param standard_attrs
//! Flag that controls how the known standard attributes stored in
//! @[Protocols.LDAP] are to be used:
pike.git/lib/modules/Protocols.pmod/LDAP.pmod/client.pike:2365:
//! oid of it. Note that the attribute description from the
//! referenced type always is merged with the current one to make
//! the returned description complete.
//! @member string "EQUALITY"
//! The value is the name or oid of a matching rule.
//! @member string "ORDERING"
//! The value is the name or oid of a matching rule.
//! @member string "SUBSTR"
//! The value is the name or oid of a matching rule.
//! @member string "syntax_oid"
- //! The value is the oid of the syntax (RFC 2252, section 4.3.2).
+ //! The value is the oid of the syntax (@rfc{2252:4.3.2@}).
//! (This is extracted from the @expr{"SYNTAX"@} term.)
//! @member string "syntax_len"
//! Optional suggested minimum upper bound of the number of
//! characters in the attribute (or bytes if the attribute is
//! binary). (This is extracted from the @expr{"SYNTAX"@} term.)
//! @member string "SINGLE-VALUE"
//! Flag. Default multi-valued.
//! @member string "COLLECTIVE"
//! Flag. Default not collective.
//! @member string "NO-USER-MODIFICATION"