remove: moving API to standalone repository
This commit is contained in:
Patrick Stewart
parent
f090f59582
commit
92f78894fb
7613 changed files with 0 additions and 488432 deletions
|
|
@ -1,175 +0,0 @@
|
|||
"""
|
||||
This script extracts information from C# files and converts it to YAML format.
|
||||
It processes C# files in a given source directory, extracts various components
|
||||
such as namespaces, classes, properties, methods, and interfaces, and then
|
||||
writes the extracted information to YAML files in a specified destination directory.
|
||||
"""
|
||||
import os
|
||||
import re
|
||||
import yaml
|
||||
from typing import Dict, List, Any
|
||||
|
||||
def parse_csharp_file(file_path: str) -> Dict[str, Any]:
|
||||
"""
|
||||
Parse a C# file and extract its components.
|
||||
Args:
|
||||
file_path (str): Path to the C# file.
|
||||
Returns:
|
||||
Dict[str, Any]: A dictionary containing extracted information:
|
||||
- name: Name of the C# file (without extension)
|
||||
- namespace: Namespace of the class
|
||||
- class_comment: Comment for the class (if any)
|
||||
- using_statements: List of using statements
|
||||
- properties: List of class properties
|
||||
- methods: List of class methods
|
||||
- interfaces: List of interfaces implemented
|
||||
"""
|
||||
with open(file_path, 'r') as file:
|
||||
content = file.read()
|
||||
|
||||
name = os.path.basename(file_path).split('.')[0]
|
||||
namespace = extract_namespace(content)
|
||||
class_comment = extract_class_comment(content)
|
||||
using_statements = extract_using_statements(content)
|
||||
properties = extract_properties(content)
|
||||
methods = extract_methods(content)
|
||||
interfaces = extract_interfaces(content)
|
||||
|
||||
return {
|
||||
"name": name,
|
||||
"namespace": namespace,
|
||||
"class_comment": class_comment,
|
||||
"using_statements": using_statements,
|
||||
"properties": properties,
|
||||
"methods": methods,
|
||||
"interfaces": interfaces
|
||||
}
|
||||
|
||||
def extract_namespace(content: str) -> str:
|
||||
"""
|
||||
Extract the namespace from C# content.
|
||||
"""
|
||||
namespace_pattern = r'namespace\s+([\w.]+)'
|
||||
match = re.search(namespace_pattern, content)
|
||||
return match.group(1) if match else ""
|
||||
|
||||
def extract_class_comment(content: str) -> str:
|
||||
"""
|
||||
Extract the class-level comment from C# content.
|
||||
"""
|
||||
class_comment_pattern = r'/\*\*(.*?)\*/\s*(?:public|internal)?\s*class'
|
||||
match = re.search(class_comment_pattern, content, re.DOTALL)
|
||||
return match.group(1).strip() if match else ""
|
||||
|
||||
def extract_using_statements(content: str) -> List[str]:
|
||||
"""
|
||||
Extract using statements from C# content.
|
||||
"""
|
||||
return re.findall(r'using\s+([\w.]+);', content)
|
||||
|
||||
def extract_properties(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract class properties and their comments from C# content.
|
||||
"""
|
||||
property_pattern = r'(?:/\*\*(.*?)\*/\s*)?(public|private|protected|internal)\s+(?:virtual\s+)?(\w+)\s+(\w+)\s*{\s*get;\s*set;\s*}'
|
||||
properties = re.findall(property_pattern, content, re.DOTALL)
|
||||
return [
|
||||
{
|
||||
"name": prop[3],
|
||||
"type": prop[2],
|
||||
"visibility": prop[1],
|
||||
"comment": prop[0].strip() if prop[0] else None
|
||||
} for prop in properties
|
||||
]
|
||||
|
||||
def extract_methods(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract class methods and their comments from C# content.
|
||||
"""
|
||||
method_pattern = r'(?:/\*\*(.*?)\*/\s*)?(public|private|protected|internal)\s+(?:virtual\s+)?(\w+)\s+(\w+)\s*\((.*?)\)'
|
||||
methods = re.findall(method_pattern, content, re.DOTALL)
|
||||
parsed_methods = []
|
||||
for method in methods:
|
||||
parsed_methods.append({
|
||||
"name": method[3],
|
||||
"return_type": method[2],
|
||||
"visibility": method[1],
|
||||
"parameters": parse_parameters(method[4]),
|
||||
"comment": method[0].strip() if method[0] else None
|
||||
})
|
||||
return parsed_methods
|
||||
|
||||
def parse_parameters(params_str: str) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Parse method parameters from a parameter string.
|
||||
"""
|
||||
params = params_str.split(',')
|
||||
parsed_params = []
|
||||
for param in params:
|
||||
param = param.strip()
|
||||
if param:
|
||||
parts = param.split()
|
||||
parsed_params.append({"type": parts[0], "name": parts[1]})
|
||||
return parsed_params
|
||||
|
||||
def extract_interfaces(content: str) -> List[str]:
|
||||
"""
|
||||
Extract interfaces implemented by the class in the C# content.
|
||||
"""
|
||||
interface_pattern = r'class\s+\w+\s*:\s*([\w,\s]+)'
|
||||
match = re.search(interface_pattern, content)
|
||||
if match:
|
||||
return [interface.strip() for interface in match.group(1).split(',')]
|
||||
return []
|
||||
|
||||
def convert_to_yaml(csharp_data: Dict[str, Any]) -> str:
|
||||
"""
|
||||
Convert extracted C# data to YAML format.
|
||||
"""
|
||||
def format_comment(comment: str) -> str:
|
||||
return '\n'.join('# ' + line.strip() for line in comment.split('\n'))
|
||||
|
||||
formatted_data = {}
|
||||
for key, value in csharp_data.items():
|
||||
if key == 'class_comment':
|
||||
formatted_data['class_comment'] = format_comment(value) if value else None
|
||||
elif key == 'properties':
|
||||
formatted_data['properties'] = [
|
||||
{**prop, 'comment': format_comment(prop['comment']) if prop['comment'] else None}
|
||||
for prop in value
|
||||
]
|
||||
elif key == 'methods':
|
||||
formatted_data['methods'] = [
|
||||
{**method, 'comment': format_comment(method['comment']) if method.get('comment') else None}
|
||||
for method in value
|
||||
]
|
||||
else:
|
||||
formatted_data[key] = value
|
||||
|
||||
return yaml.dump(formatted_data, sort_keys=False, default_flow_style=False)
|
||||
|
||||
def process_directory(source_dir: str, dest_dir: str):
|
||||
"""
|
||||
Process all C# files in the source directory and its subdirectories,
|
||||
extract information, and save as YAML files in the destination directory.
|
||||
"""
|
||||
for root, dirs, files in os.walk(source_dir):
|
||||
for file in files:
|
||||
if file.endswith('.cs'):
|
||||
source_path = os.path.join(root, file)
|
||||
relative_path = os.path.relpath(source_path, source_dir)
|
||||
dest_path = os.path.join(dest_dir, os.path.dirname(relative_path))
|
||||
os.makedirs(dest_path, exist_ok=True)
|
||||
|
||||
csharp_data = parse_csharp_file(source_path)
|
||||
yaml_content = convert_to_yaml(csharp_data)
|
||||
|
||||
yaml_file = os.path.join(dest_path, f"{os.path.splitext(file)[0]}.yaml")
|
||||
with open(yaml_file, 'w') as f:
|
||||
f.write(yaml_content)
|
||||
|
||||
if __name__ == "__main__":
|
||||
source_directory = "/path/to/csharp/source/directory"
|
||||
destination_directory = "/path/to/yaml/destination/directory"
|
||||
process_directory(source_directory, destination_directory)
|
||||
print("Extraction and conversion completed.")
|
||||
|
|
@ -1,127 +0,0 @@
|
|||
"""
|
||||
This script extracts information from Erlang files and converts it to YAML format.
|
||||
It processes Erlang files in a given source directory, extracts various components
|
||||
such as module name, exports, imports, records, and functions, and then writes the
|
||||
extracted information to YAML files in a specified destination directory.
|
||||
"""
|
||||
import os
|
||||
import re
|
||||
import yaml
|
||||
from typing import Dict, List, Any
|
||||
|
||||
def parse_erlang_file(file_path: str) -> Dict[str, Any]:
|
||||
"""
|
||||
Parse an Erlang file and extract its components.
|
||||
Args:
|
||||
file_path (str): Path to the Erlang file.
|
||||
Returns:
|
||||
Dict[str, Any]: A dictionary containing extracted information:
|
||||
- name: Name of the Erlang file (without extension)
|
||||
- module: Module name
|
||||
- exports: List of exported functions
|
||||
- imports: List of imported functions
|
||||
- records: List of record definitions
|
||||
- functions: List of function definitions
|
||||
"""
|
||||
with open(file_path, 'r') as file:
|
||||
content = file.read()
|
||||
|
||||
name = os.path.basename(file_path).split('.')[0]
|
||||
module = extract_module(content)
|
||||
exports = extract_exports(content)
|
||||
imports = extract_imports(content)
|
||||
records = extract_records(content)
|
||||
functions = extract_functions(content)
|
||||
|
||||
return {
|
||||
"name": name,
|
||||
"module": module,
|
||||
"exports": exports,
|
||||
"imports": imports,
|
||||
"records": records,
|
||||
"functions": functions
|
||||
}
|
||||
|
||||
def extract_module(content: str) -> str:
|
||||
"""Extract the module name from Erlang content."""
|
||||
module_pattern = r'-module\(([^)]+)\)'
|
||||
match = re.search(module_pattern, content)
|
||||
return match.group(1) if match else ""
|
||||
|
||||
def extract_exports(content: str) -> List[Dict[str, Any]]:
|
||||
"""Extract exported functions from Erlang content."""
|
||||
export_pattern = r'-export\(\[(.*?)\]\)'
|
||||
exports = []
|
||||
for match in re.finditer(export_pattern, content):
|
||||
exports.extend(parse_function_exports(match.group(1)))
|
||||
return exports
|
||||
|
||||
def parse_function_exports(export_str: str) -> List[Dict[str, Any]]:
|
||||
"""Parse exported function definitions."""
|
||||
function_pattern = r'(\w+)/(\d+)'
|
||||
return [{"name": match[0], "arity": int(match[1])} for match in re.findall(function_pattern, export_str)]
|
||||
|
||||
def extract_imports(content: str) -> List[Dict[str, Any]]:
|
||||
"""Extract imported functions from Erlang content."""
|
||||
import_pattern = r'-import\(([^,]+),\s*\[(.*?)\]\)'
|
||||
imports = []
|
||||
for match in re.finditer(import_pattern, content):
|
||||
module = match.group(1)
|
||||
functions = parse_function_exports(match.group(2))
|
||||
imports.append({"module": module, "functions": functions})
|
||||
return imports
|
||||
|
||||
def extract_records(content: str) -> List[Dict[str, Any]]:
|
||||
"""Extract record definitions from Erlang content."""
|
||||
record_pattern = r'-record\((\w+),\s*\{(.*?)\}\)'
|
||||
records = []
|
||||
for match in re.finditer(record_pattern, content):
|
||||
name = match.group(1)
|
||||
fields = [field.strip() for field in match.group(2).split(',')]
|
||||
records.append({"name": name, "fields": fields})
|
||||
return records
|
||||
|
||||
def extract_functions(content: str) -> List[Dict[str, Any]]:
|
||||
"""Extract function definitions from Erlang content."""
|
||||
function_pattern = r'(\w+)\((.*?)\)\s*->(.*?)(?=\w+\(|\Z)'
|
||||
functions = []
|
||||
for match in re.finditer(function_pattern, content, re.DOTALL):
|
||||
name = match.group(1)
|
||||
params = [param.strip() for param in match.group(2).split(',')]
|
||||
body = match.group(3).strip()
|
||||
functions.append({
|
||||
"name": name,
|
||||
"parameters": params,
|
||||
"body": body
|
||||
})
|
||||
return functions
|
||||
|
||||
def convert_to_yaml(erlang_data: Dict[str, Any]) -> str:
|
||||
"""Convert extracted Erlang data to YAML format."""
|
||||
return yaml.dump(erlang_data, sort_keys=False, default_flow_style=False)
|
||||
|
||||
def process_directory(source_dir: str, dest_dir: str):
|
||||
"""
|
||||
Process all Erlang files in the source directory and its subdirectories,
|
||||
extract information, and save as YAML files in the destination directory.
|
||||
"""
|
||||
for root, dirs, files in os.walk(source_dir):
|
||||
for file in files:
|
||||
if file.endswith('.erl'):
|
||||
source_path = os.path.join(root, file)
|
||||
relative_path = os.path.relpath(source_path, source_dir)
|
||||
dest_path = os.path.join(dest_dir, os.path.dirname(relative_path))
|
||||
os.makedirs(dest_path, exist_ok=True)
|
||||
|
||||
erlang_data = parse_erlang_file(source_path)
|
||||
yaml_content = convert_to_yaml(erlang_data)
|
||||
|
||||
yaml_file = os.path.join(dest_path, f"{os.path.splitext(file)[0]}.yaml")
|
||||
with open(yaml_file, 'w') as f:
|
||||
f.write(yaml_content)
|
||||
|
||||
if __name__ == "__main__":
|
||||
source_directory = "/path/to/erlang/source/directory"
|
||||
destination_directory = "/path/to/yaml/destination/directory"
|
||||
process_directory(source_directory, destination_directory)
|
||||
print("Extraction and conversion completed.")
|
||||
|
|
@ -1,198 +0,0 @@
|
|||
"""
|
||||
This script extracts information from Go files and converts it to YAML format.
|
||||
It processes Go files in a given source directory, extracts various components
|
||||
such as imports, structs, interfaces, and functions, and then writes the
|
||||
extracted information to YAML files in a specified destination directory.
|
||||
"""
|
||||
import os
|
||||
import re
|
||||
import yaml
|
||||
from typing import Dict, List, Any
|
||||
|
||||
def parse_go_file(file_path: str) -> Dict[str, Any]:
|
||||
"""
|
||||
Parse a Go file and extract its components.
|
||||
Args:
|
||||
file_path (str): Path to the Go file.
|
||||
Returns:
|
||||
Dict[str, Any]: A dictionary containing extracted information:
|
||||
- name: Name of the Go file (without extension)
|
||||
- package: Package name
|
||||
- imports: List of import statements
|
||||
- structs: List of struct definitions
|
||||
- interfaces: List of interface definitions
|
||||
- functions: List of function definitions
|
||||
"""
|
||||
with open(file_path, 'r') as file:
|
||||
content = file.read()
|
||||
|
||||
name = os.path.basename(file_path).split('.')[0]
|
||||
package = extract_package(content)
|
||||
imports = extract_imports(content)
|
||||
structs = extract_structs(content)
|
||||
interfaces = extract_interfaces(content)
|
||||
functions = extract_functions(content)
|
||||
|
||||
return {
|
||||
"name": name,
|
||||
"package": package,
|
||||
"imports": imports,
|
||||
"structs": structs,
|
||||
"interfaces": interfaces,
|
||||
"functions": functions
|
||||
}
|
||||
|
||||
def extract_package(content: str) -> str:
|
||||
"""
|
||||
Extract the package name from Go content.
|
||||
"""
|
||||
package_pattern = r'package\s+(\w+)'
|
||||
match = re.search(package_pattern, content)
|
||||
return match.group(1) if match else ""
|
||||
|
||||
def extract_imports(content: str) -> List[str]:
|
||||
"""
|
||||
Extract import statements from Go content.
|
||||
"""
|
||||
import_pattern = r'import\s*\((.*?)\)'
|
||||
match = re.search(import_pattern, content, re.DOTALL)
|
||||
if match:
|
||||
imports = re.findall(r'"(.+?)"', match.group(1))
|
||||
return imports
|
||||
return []
|
||||
|
||||
def extract_structs(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract struct definitions from Go content.
|
||||
"""
|
||||
struct_pattern = r'//\s*(.+?)?\n\s*type\s+(\w+)\s+struct\s*{([^}]+)}'
|
||||
structs = re.findall(struct_pattern, content, re.DOTALL)
|
||||
return [
|
||||
{
|
||||
"name": struct[1],
|
||||
"comment": struct[0].strip() if struct[0] else None,
|
||||
"fields": extract_struct_fields(struct[2])
|
||||
} for struct in structs
|
||||
]
|
||||
|
||||
def extract_struct_fields(fields_str: str) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Extract fields from a struct definition.
|
||||
"""
|
||||
field_pattern = r'(\w+)\s+(.+?)(?:`[^`]*`)?$'
|
||||
return [
|
||||
{"name": field[0], "type": field[1].strip()}
|
||||
for field in re.findall(field_pattern, fields_str, re.MULTILINE)
|
||||
]
|
||||
|
||||
def extract_interfaces(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract interface definitions from Go content.
|
||||
"""
|
||||
interface_pattern = r'//\s*(.+?)?\n\s*type\s+(\w+)\s+interface\s*{([^}]+)}'
|
||||
interfaces = re.findall(interface_pattern, content, re.DOTALL)
|
||||
return [
|
||||
{
|
||||
"name": interface[1],
|
||||
"comment": interface[0].strip() if interface[0] else None,
|
||||
"methods": extract_interface_methods(interface[2])
|
||||
} for interface in interfaces
|
||||
]
|
||||
|
||||
def extract_interface_methods(interface_content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract method signatures from an interface definition.
|
||||
"""
|
||||
method_pattern = r'(\w+)\((.*?)\)\s*(.*?)(?:\s*//.*)?$'
|
||||
methods = re.findall(method_pattern, interface_content, re.MULTILINE)
|
||||
return [
|
||||
{
|
||||
"name": method[0],
|
||||
"parameters": parse_parameters(method[1]),
|
||||
"return_type": method[2].strip() if method[2] else None
|
||||
} for method in methods
|
||||
]
|
||||
|
||||
def extract_functions(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract function definitions from Go content.
|
||||
"""
|
||||
function_pattern = r'//\s*(.+?)?\n\s*func\s+(\w+)\s*\((.*?)\)\s*(.*?)\s*{'
|
||||
functions = re.findall(function_pattern, content, re.DOTALL)
|
||||
return [
|
||||
{
|
||||
"name": function[1],
|
||||
"comment": function[0].strip() if function[0] else None,
|
||||
"receiver": extract_receiver(function[2]),
|
||||
"parameters": parse_parameters(function[2]),
|
||||
"return_type": function[3].strip() if function[3] else None
|
||||
} for function in functions
|
||||
]
|
||||
|
||||
def extract_receiver(params_str: str) -> Dict[str, str]:
|
||||
"""
|
||||
Extract the receiver from a method signature.
|
||||
"""
|
||||
receiver_pattern = r'(\w+)\s+\*?(\w+)'
|
||||
match = re.match(receiver_pattern, params_str)
|
||||
if match:
|
||||
return {"name": match.group(1), "type": match.group(2)}
|
||||
return {}
|
||||
|
||||
def parse_parameters(params_str: str) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Parse function parameters from a parameter string.
|
||||
"""
|
||||
params = params_str.split(',')
|
||||
parsed_params = []
|
||||
for param in params:
|
||||
param = param.strip()
|
||||
if param and not re.match(r'^\w+\s+\*?\w+$', param): # Skip receiver
|
||||
parts = param.split()
|
||||
parsed_params.append({"name": parts[0], "type": ' '.join(parts[1:])})
|
||||
return parsed_params
|
||||
|
||||
def convert_to_yaml(go_data: Dict[str, Any]) -> str:
|
||||
"""
|
||||
Convert extracted Go data to YAML format.
|
||||
"""
|
||||
def format_comment(comment: str) -> str:
|
||||
return '\n'.join('# ' + line.strip() for line in comment.split('\n'))
|
||||
|
||||
formatted_data = {}
|
||||
for key, value in go_data.items():
|
||||
if key in ['structs', 'interfaces', 'functions']:
|
||||
formatted_data[key] = [
|
||||
{**item, 'comment': format_comment(item['comment']) if item.get('comment') else None}
|
||||
for item in value
|
||||
]
|
||||
else:
|
||||
formatted_data[key] = value
|
||||
|
||||
return yaml.dump(formatted_data, sort_keys=False, default_flow_style=False)
|
||||
|
||||
def process_directory(source_dir: str, dest_dir: str):
|
||||
"""
|
||||
Process all Go files in the source directory and its subdirectories,
|
||||
extract information, and save as YAML files in the destination directory.
|
||||
"""
|
||||
for root, dirs, files in os.walk(source_dir):
|
||||
for file in files:
|
||||
if file.endswith('.go'):
|
||||
source_path = os.path.join(root, file)
|
||||
relative_path = os.path.relpath(source_path, source_dir)
|
||||
dest_path = os.path.join(dest_dir, os.path.dirname(relative_path))
|
||||
os.makedirs(dest_path, exist_ok=True)
|
||||
|
||||
go_data = parse_go_file(source_path)
|
||||
yaml_content = convert_to_yaml(go_data)
|
||||
|
||||
yaml_file = os.path.join(dest_path, f"{os.path.splitext(file)[0]}.yaml")
|
||||
with open(yaml_file, 'w') as f:
|
||||
f.write(yaml_content)
|
||||
|
||||
if __name__ == "__main__":
|
||||
source_directory = "/path/to/go/source/directory"
|
||||
destination_directory = "/path/to/yaml/destination/directory"
|
||||
process_directory(source_directory, destination_directory)
|
||||
print("Extraction and conversion completed.")
|
||||
|
|
@ -1,171 +0,0 @@
|
|||
"""
|
||||
This script extracts information from Java files and converts it to YAML format.
|
||||
It processes Java files in a given source directory, extracts various components
|
||||
such as package, imports, class info, fields, methods, and interfaces, and then
|
||||
writes the extracted information to YAML files in a specified destination directory.
|
||||
"""
|
||||
import os
|
||||
import re
|
||||
import yaml
|
||||
from typing import Dict, List, Any
|
||||
|
||||
def parse_java_file(file_path: str) -> Dict[str, Any]:
|
||||
"""
|
||||
Parse a Java file and extract its components.
|
||||
Args:
|
||||
file_path (str): Path to the Java file.
|
||||
Returns:
|
||||
Dict[str, Any]: A dictionary containing extracted information:
|
||||
- name: Name of the Java file (without extension)
|
||||
- package: Package declaration
|
||||
- imports: List of import statements
|
||||
- class_info: Information about the class (name, modifiers, extends, implements)
|
||||
- class_comment: Comment for the class (if any)
|
||||
- fields: List of class fields
|
||||
- methods: List of class methods
|
||||
- interfaces: List of interfaces implemented
|
||||
"""
|
||||
with open(file_path, 'r') as file:
|
||||
content = file.read()
|
||||
|
||||
name = os.path.basename(file_path).split('.')[0]
|
||||
package = extract_package(content)
|
||||
imports = extract_imports(content)
|
||||
class_info = extract_class_info(content)
|
||||
class_comment = extract_class_comment(content)
|
||||
fields = extract_fields(content)
|
||||
methods = extract_methods(content)
|
||||
interfaces = extract_interfaces(content)
|
||||
|
||||
return {
|
||||
"name": name,
|
||||
"package": package,
|
||||
"imports": imports,
|
||||
"class_info": class_info,
|
||||
"class_comment": class_comment,
|
||||
"fields": fields,
|
||||
"methods": methods,
|
||||
"interfaces": interfaces
|
||||
}
|
||||
|
||||
def extract_package(content: str) -> str:
|
||||
"""Extract the package declaration from Java content."""
|
||||
package_pattern = r'package\s+([\w.]+);'
|
||||
match = re.search(package_pattern, content)
|
||||
return match.group(1) if match else ""
|
||||
|
||||
def extract_imports(content: str) -> List[str]:
|
||||
"""Extract import statements from Java content."""
|
||||
import_pattern = r'import\s+([\w.]+);'
|
||||
return re.findall(import_pattern, content)
|
||||
|
||||
def extract_class_info(content: str) -> Dict[str, Any]:
|
||||
"""Extract class information from Java content."""
|
||||
class_pattern = r'(public\s+)?(abstract\s+)?(final\s+)?class\s+(\w+)(\s+extends\s+\w+)?(\s+implements\s+[\w,\s]+)?'
|
||||
match = re.search(class_pattern, content)
|
||||
if match:
|
||||
return {
|
||||
"name": match.group(4),
|
||||
"modifiers": [mod for mod in [match.group(1), match.group(2), match.group(3)] if mod],
|
||||
"extends": match.group(5).split()[-1] if match.group(5) else None,
|
||||
"implements": match.group(6).split()[-1].split(',') if match.group(6) else []
|
||||
}
|
||||
return {}
|
||||
|
||||
def extract_class_comment(content: str) -> str:
|
||||
"""Extract the class-level comment from Java content."""
|
||||
class_comment_pattern = r'/\*\*(.*?)\*/\s*(?:public\s+)?(?:abstract\s+)?(?:final\s+)?class'
|
||||
match = re.search(class_comment_pattern, content, re.DOTALL)
|
||||
return match.group(1).strip() if match else ""
|
||||
|
||||
def extract_fields(content: str) -> List[Dict[str, Any]]:
|
||||
"""Extract class fields from Java content."""
|
||||
field_pattern = r'(?:/\*\*(.*?)\*/\s*)?(public|protected|private)\s+(?:static\s+)?(?:final\s+)?(\w+)\s+(\w+)(?:\s*=\s*[^;]+)?;'
|
||||
fields = re.findall(field_pattern, content, re.DOTALL)
|
||||
return [
|
||||
{
|
||||
"name": field[3],
|
||||
"type": field[2],
|
||||
"visibility": field[1],
|
||||
"comment": field[0].strip() if field[0] else None
|
||||
} for field in fields
|
||||
]
|
||||
|
||||
def extract_methods(content: str) -> List[Dict[str, Any]]:
|
||||
"""Extract class methods from Java content."""
|
||||
method_pattern = r'(?:/\*\*(.*?)\*/\s*)?(public|protected|private)\s+(?:static\s+)?(?:\w+\s+)?(\w+)\s+(\w+)\s*\((.*?)\)'
|
||||
methods = re.findall(method_pattern, content, re.DOTALL)
|
||||
parsed_methods = []
|
||||
for method in methods:
|
||||
parsed_methods.append({
|
||||
"name": method[3],
|
||||
"return_type": method[2],
|
||||
"visibility": method[1],
|
||||
"parameters": parse_parameters(method[4]),
|
||||
"comment": method[0].strip() if method[0] else None
|
||||
})
|
||||
return parsed_methods
|
||||
|
||||
def parse_parameters(params_str: str) -> List[Dict[str, str]]:
|
||||
"""Parse method parameters from a parameter string."""
|
||||
params = params_str.split(',')
|
||||
parsed_params = []
|
||||
for param in params:
|
||||
param = param.strip()
|
||||
if param:
|
||||
parts = param.split()
|
||||
parsed_params.append({"type": parts[0], "name": parts[1]})
|
||||
return parsed_params
|
||||
|
||||
def extract_interfaces(content: str) -> List[str]:
|
||||
"""Extract interfaces implemented by the class in the Java content."""
|
||||
interface_pattern = r'implements\s+([\w,\s]+)'
|
||||
match = re.search(interface_pattern, content)
|
||||
if match:
|
||||
return [interface.strip() for interface in match.group(1).split(',')]
|
||||
return []
|
||||
|
||||
def convert_to_yaml(java_data: Dict[str, Any]) -> str:
|
||||
"""Convert extracted Java data to YAML format."""
|
||||
def format_comment(comment: str) -> str:
|
||||
return '\n'.join('# ' + line.strip() for line in comment.split('\n'))
|
||||
|
||||
formatted_data = {}
|
||||
for key, value in java_data.items():
|
||||
if key == 'class_comment':
|
||||
formatted_data['class_comment'] = format_comment(value) if value else None
|
||||
elif key in ['fields', 'methods']:
|
||||
formatted_data[key] = [
|
||||
{**item, 'comment': format_comment(item['comment']) if item.get('comment') else None}
|
||||
for item in value
|
||||
]
|
||||
else:
|
||||
formatted_data[key] = value
|
||||
|
||||
return yaml.dump(formatted_data, sort_keys=False, default_flow_style=False)
|
||||
|
||||
def process_directory(source_dir: str, dest_dir: str):
|
||||
"""
|
||||
Process all Java files in the source directory and its subdirectories,
|
||||
extract information, and save as YAML files in the destination directory.
|
||||
"""
|
||||
for root, dirs, files in os.walk(source_dir):
|
||||
for file in files:
|
||||
if file.endswith('.java'):
|
||||
source_path = os.path.join(root, file)
|
||||
relative_path = os.path.relpath(source_path, source_dir)
|
||||
dest_path = os.path.join(dest_dir, os.path.dirname(relative_path))
|
||||
os.makedirs(dest_path, exist_ok=True)
|
||||
|
||||
java_data = parse_java_file(source_path)
|
||||
yaml_content = convert_to_yaml(java_data)
|
||||
|
||||
yaml_file = os.path.join(dest_path, f"{os.path.splitext(file)[0]}.yaml")
|
||||
with open(yaml_file, 'w') as f:
|
||||
f.write(yaml_content)
|
||||
|
||||
if __name__ == "__main__":
|
||||
source_directory = "/path/to/java/source/directory"
|
||||
destination_directory = "/path/to/yaml/destination/directory"
|
||||
process_directory(source_directory, destination_directory)
|
||||
print("Extraction and conversion completed.")
|
||||
|
|
@ -1,149 +0,0 @@
|
|||
"""
|
||||
This script extracts information from JavaScript files and converts it to YAML format.
|
||||
It processes JavaScript files in a given source directory, extracts various components
|
||||
such as imports, classes, properties, and methods, and then writes the extracted
|
||||
information to YAML files in a specified destination directory.
|
||||
"""
|
||||
import os
|
||||
import re
|
||||
import yaml
|
||||
from typing import Dict, List, Any
|
||||
|
||||
def parse_javascript_file(file_path: str) -> Dict[str, Any]:
|
||||
"""
|
||||
Parse a JavaScript file and extract its components.
|
||||
Args:
|
||||
file_path (str): Path to the JavaScript file.
|
||||
Returns:
|
||||
Dict[str, Any]: A dictionary containing extracted information:
|
||||
- name: Name of the JavaScript file (without extension)
|
||||
- imports: List of import statements
|
||||
- class_comment: Comment for the class (if any)
|
||||
- class_name: Name of the class
|
||||
- properties: List of class properties
|
||||
- methods: List of class methods
|
||||
"""
|
||||
with open(file_path, 'r') as file:
|
||||
content = file.read()
|
||||
|
||||
name = os.path.basename(file_path).split('.')[0]
|
||||
imports = extract_imports(content)
|
||||
class_comment, class_name = extract_class_info(content)
|
||||
properties = extract_properties(content)
|
||||
methods = extract_methods(content)
|
||||
|
||||
return {
|
||||
"name": name,
|
||||
"imports": imports,
|
||||
"class_comment": class_comment,
|
||||
"class_name": class_name,
|
||||
"properties": properties,
|
||||
"methods": methods
|
||||
}
|
||||
|
||||
def extract_imports(content: str) -> List[str]:
|
||||
"""
|
||||
Extract import statements from JavaScript content.
|
||||
"""
|
||||
import_pattern = r'import\s+.*?from\s+[\'"].*?[\'"];'
|
||||
return re.findall(import_pattern, content)
|
||||
|
||||
def extract_class_info(content: str) -> tuple:
|
||||
"""
|
||||
Extract class comment and name from JavaScript content.
|
||||
"""
|
||||
class_pattern = r'(/\*\*(.*?)\*/\s*)?class\s+(\w+)'
|
||||
match = re.search(class_pattern, content, re.DOTALL)
|
||||
if match:
|
||||
comment = match.group(2).strip() if match.group(2) else ""
|
||||
name = match.group(3)
|
||||
return comment, name
|
||||
return "", ""
|
||||
|
||||
def extract_properties(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract class properties from JavaScript content.
|
||||
"""
|
||||
property_pattern = r'(/\*\*(.*?)\*/\s*)?(static\s+)?(\w+)\s*=\s*'
|
||||
properties = re.findall(property_pattern, content, re.DOTALL)
|
||||
return [
|
||||
{
|
||||
"name": prop[3],
|
||||
"static": bool(prop[2]),
|
||||
"comment": prop[1].strip() if prop[1] else None
|
||||
} for prop in properties
|
||||
]
|
||||
|
||||
def extract_methods(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract class methods from JavaScript content.
|
||||
"""
|
||||
method_pattern = r'(/\*\*(.*?)\*/\s*)?(static\s+)?(\w+)\s*\((.*?)\)\s*{'
|
||||
methods = re.findall(method_pattern, content, re.DOTALL)
|
||||
parsed_methods = []
|
||||
for method in methods:
|
||||
parsed_methods.append({
|
||||
"name": method[3],
|
||||
"static": bool(method[2]),
|
||||
"parameters": parse_parameters(method[4]),
|
||||
"comment": method[1].strip() if method[1] else None
|
||||
})
|
||||
return parsed_methods
|
||||
|
||||
def parse_parameters(params_str: str) -> List[str]:
|
||||
"""
|
||||
Parse method parameters from a parameter string.
|
||||
"""
|
||||
return [param.strip() for param in params_str.split(',') if param.strip()]
|
||||
|
||||
def convert_to_yaml(js_data: Dict[str, Any]) -> str:
|
||||
"""
|
||||
Convert extracted JavaScript data to YAML format.
|
||||
"""
|
||||
def format_comment(comment: str) -> str:
|
||||
return '\n'.join('# ' + line.strip() for line in comment.split('\n'))
|
||||
|
||||
formatted_data = {}
|
||||
for key, value in js_data.items():
|
||||
if key == 'class_comment':
|
||||
formatted_data['class_comment'] = format_comment(value) if value else None
|
||||
elif key == 'properties':
|
||||
formatted_data['properties'] = [
|
||||
{**prop, 'comment': format_comment(prop['comment']) if prop['comment'] else None}
|
||||
for prop in value
|
||||
]
|
||||
elif key == 'methods':
|
||||
formatted_data['methods'] = [
|
||||
{**method, 'comment': format_comment(method['comment']) if method.get('comment') else None}
|
||||
for method in value
|
||||
]
|
||||
else:
|
||||
formatted_data[key] = value
|
||||
|
||||
return yaml.dump(formatted_data, sort_keys=False, default_flow_style=False)
|
||||
|
||||
def process_directory(source_dir: str, dest_dir: str):
|
||||
"""
|
||||
Process all JavaScript files in the source directory and its subdirectories,
|
||||
extract information, and save as YAML files in the destination directory.
|
||||
"""
|
||||
for root, dirs, files in os.walk(source_dir):
|
||||
for file in files:
|
||||
if file.endswith('.js'):
|
||||
source_path = os.path.join(root, file)
|
||||
relative_path = os.path.relpath(source_path, source_dir)
|
||||
dest_path = os.path.join(dest_dir, os.path.dirname(relative_path))
|
||||
os.makedirs(dest_path, exist_ok=True)
|
||||
|
||||
js_data = parse_javascript_file(source_path)
|
||||
yaml_content = convert_to_yaml(js_data)
|
||||
|
||||
yaml_file = os.path.join(dest_path, f"{os.path.splitext(file)[0]}.yaml")
|
||||
with open(yaml_file, 'w') as f:
|
||||
f.write(yaml_content)
|
||||
|
||||
if __name__ == "__main__":
|
||||
source_directory = "/path/to/javascript/source/directory"
|
||||
destination_directory = "/path/to/yaml/destination/directory"
|
||||
process_directory(source_directory, destination_directory)
|
||||
print("Extraction and conversion completed.")
|
||||
|
|
@ -1,253 +0,0 @@
|
|||
"""
|
||||
This script extracts information from PHP files and converts it to YAML format.
|
||||
It processes PHP files in a given source directory, extracts various components
|
||||
such as dependencies, properties, methods, traits, and interfaces, and then
|
||||
writes the extracted information to YAML files in a specified destination directory.
|
||||
"""
|
||||
|
||||
import os
|
||||
import re
|
||||
import yaml
|
||||
from typing import Dict, List, Any
|
||||
|
||||
def parse_php_file(file_path: str) -> Dict[str, Any]:
|
||||
"""
|
||||
Parse a PHP file and extract its components.
|
||||
|
||||
Args:
|
||||
file_path (str): Path to the PHP file.
|
||||
|
||||
Returns:
|
||||
Dict[str, Any]: A dictionary containing extracted information:
|
||||
- name: Name of the PHP file (without extension)
|
||||
- class_comment: Comment for the class (if any)
|
||||
- dependencies: List of dependencies (use statements)
|
||||
- properties: List of class properties
|
||||
- methods: List of class methods
|
||||
- traits: List of traits used
|
||||
- interfaces: List of interfaces implemented
|
||||
"""
|
||||
with open(file_path, 'r') as file:
|
||||
content = file.read()
|
||||
|
||||
name = os.path.basename(file_path).split('.')[0]
|
||||
class_comment = extract_class_comment(content)
|
||||
dependencies = extract_dependencies(content)
|
||||
properties = extract_properties(content)
|
||||
methods = extract_methods(content)
|
||||
traits = extract_traits(content)
|
||||
interfaces = extract_interfaces(content)
|
||||
|
||||
return {
|
||||
"name": name,
|
||||
"class_comment": class_comment,
|
||||
"dependencies": dependencies,
|
||||
"properties": properties,
|
||||
"methods": methods,
|
||||
"traits": traits,
|
||||
"interfaces": interfaces
|
||||
}
|
||||
|
||||
def extract_class_comment(content: str) -> str:
|
||||
"""
|
||||
Extract the class-level comment from PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
str: Extracted class comment or empty string if not found.
|
||||
"""
|
||||
class_comment_pattern = r'/\*\*(.*?)\*/\s*class'
|
||||
match = re.search(class_comment_pattern, content, re.DOTALL)
|
||||
if match:
|
||||
return match.group(1).strip()
|
||||
return ""
|
||||
|
||||
def extract_dependencies(content: str) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Extract dependencies (use statements) from PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[Dict[str, str]]: List of dictionaries containing dependency information:
|
||||
- name: Alias or class name
|
||||
- type: Always "class" for now (might need refinement)
|
||||
- source: Full namespace of the dependency
|
||||
"""
|
||||
# Regex pattern to match use statements, capturing the full namespace and optional alias
|
||||
use_statements = re.findall(r'use\s+([\w\\]+)(?:\s+as\s+(\w+))?;', content)
|
||||
dependencies = []
|
||||
for use in use_statements:
|
||||
dep = {
|
||||
"name": use[1] if use[1] else use[0].split('\\')[-1],
|
||||
"type": "class", # Assuming class for now, might need refinement
|
||||
"source": use[0]
|
||||
}
|
||||
dependencies.append(dep)
|
||||
return dependencies
|
||||
|
||||
def extract_properties(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract class properties and their comments from PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[Dict[str, Any]]: List of dictionaries containing property information:
|
||||
- name: Property name (without $)
|
||||
- visibility: public, protected, or private
|
||||
- comment: Property comment (if any)
|
||||
"""
|
||||
# Regex pattern to match property declarations with optional comments
|
||||
property_pattern = r'(?:/\*\*(.*?)\*/\s*)?(public|protected|private)\s+(?:static\s+)?(\$\w+)(?:\s*=\s*[^;]+)?;'
|
||||
properties = re.findall(property_pattern, content, re.DOTALL)
|
||||
return [
|
||||
{
|
||||
"name": prop[2][1:],
|
||||
"visibility": prop[1],
|
||||
"comment": prop[0].strip() if prop[0] else None
|
||||
} for prop in properties
|
||||
]
|
||||
|
||||
def extract_methods(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract class methods and their comments from PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[Dict[str, Any]]: List of dictionaries containing method information:
|
||||
- name: Method name
|
||||
- visibility: public, protected, or private
|
||||
- parameters: List of parameter dictionaries
|
||||
- comment: Method comment (if any)
|
||||
"""
|
||||
# Regex pattern to match method declarations with optional comments
|
||||
method_pattern = r'(?:/\*\*(.*?)\*/\s*)?(public|protected|private)\s+(?:static\s+)?function\s+(\w+)\s*\((.*?)\)'
|
||||
methods = re.findall(method_pattern, content, re.DOTALL)
|
||||
parsed_methods = []
|
||||
for method in methods:
|
||||
parsed_methods.append({
|
||||
"name": method[2],
|
||||
"visibility": method[1],
|
||||
"parameters": parse_parameters(method[3]),
|
||||
"comment": method[0].strip() if method[0] else None
|
||||
})
|
||||
return parsed_methods
|
||||
|
||||
def parse_parameters(params_str: str) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Parse method parameters from a parameter string.
|
||||
|
||||
Args:
|
||||
params_str (str): String containing method parameters.
|
||||
|
||||
Returns:
|
||||
List[Dict[str, str]]: List of dictionaries containing parameter information:
|
||||
- name: Parameter name
|
||||
- default: Default value (if specified)
|
||||
"""
|
||||
params = params_str.split(',')
|
||||
parsed_params = []
|
||||
for param in params:
|
||||
param = param.strip()
|
||||
if param:
|
||||
parts = param.split('=')
|
||||
param_dict = {"name": parts[0].split()[-1].strip('$')}
|
||||
if len(parts) > 1:
|
||||
param_dict["default"] = parts[1].strip()
|
||||
parsed_params.append(param_dict)
|
||||
return parsed_params
|
||||
|
||||
def extract_traits(content: str) -> List[str]:
|
||||
"""
|
||||
Extract traits used in the PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[str]: List of trait names used in the class.
|
||||
"""
|
||||
return re.findall(r'use\s+([\w\\]+)(?:,\s*[\w\\]+)*;', content)
|
||||
|
||||
def extract_interfaces(content: str) -> List[str]:
|
||||
"""
|
||||
Extract interfaces implemented by the class in the PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[str]: List of interface names implemented by the class.
|
||||
"""
|
||||
return re.findall(r'implements\s+([\w\\]+)(?:,\s*[\w\\]+)*', content)
|
||||
|
||||
def convert_to_yaml(php_data: Dict[str, Any]) -> str:
|
||||
"""
|
||||
Convert extracted PHP data to YAML format.
|
||||
|
||||
Args:
|
||||
php_data (Dict[str, Any]): Dictionary containing extracted PHP data.
|
||||
|
||||
Returns:
|
||||
str: YAML representation of the PHP data.
|
||||
"""
|
||||
def format_comment(comment: str) -> str:
|
||||
return '\n'.join('# ' + line.strip() for line in comment.split('\n'))
|
||||
|
||||
formatted_data = {}
|
||||
for key, value in php_data.items():
|
||||
if key == 'class_comment':
|
||||
formatted_data['class_comment'] = format_comment(value) if value else None
|
||||
elif key == 'properties':
|
||||
formatted_data['properties'] = [
|
||||
{**prop, 'comment': format_comment(prop['comment']) if prop['comment'] else None}
|
||||
for prop in value
|
||||
]
|
||||
elif key == 'methods':
|
||||
formatted_data['methods'] = [
|
||||
{**method, 'comment': format_comment(method['comment']) if method.get('comment') else None}
|
||||
for method in value
|
||||
]
|
||||
else:
|
||||
formatted_data[key] = value
|
||||
|
||||
return yaml.dump(formatted_data, sort_keys=False, default_flow_style=False)
|
||||
|
||||
def process_directory(source_dir: str, dest_dir: str):
|
||||
"""
|
||||
Process all PHP files in the source directory and its subdirectories,
|
||||
extract information, and save as YAML files in the destination directory.
|
||||
|
||||
Args:
|
||||
source_dir (str): Path to the source directory containing PHP files.
|
||||
dest_dir (str): Path to the destination directory for YAML files.
|
||||
"""
|
||||
for root, dirs, files in os.walk(source_dir):
|
||||
for file in files:
|
||||
if file.endswith('.php'):
|
||||
source_path = os.path.join(root, file)
|
||||
relative_path = os.path.relpath(source_path, source_dir)
|
||||
dest_path = os.path.join(dest_dir, os.path.dirname(relative_path))
|
||||
|
||||
os.makedirs(dest_path, exist_ok=True)
|
||||
|
||||
php_data = parse_php_file(source_path)
|
||||
yaml_content = convert_to_yaml(php_data)
|
||||
|
||||
yaml_file = os.path.join(dest_path, f"{os.path.splitext(file)[0]}.yaml")
|
||||
with open(yaml_file, 'w') as f:
|
||||
f.write(yaml_content)
|
||||
|
||||
if __name__ == "__main__":
|
||||
source_directory = "/home/platform/Devboxes/resources/laravel_framework/src/Illuminate/"
|
||||
destination_directory = "/home/platform/Devboxes/platform/api/"
|
||||
|
||||
process_directory(source_directory, destination_directory)
|
||||
print("Extraction and conversion completed.")
|
||||
|
|
@ -1,253 +0,0 @@
|
|||
"""
|
||||
This script extracts information from PHP files and converts it to YAML format.
|
||||
It processes PHP files in a given source directory, extracts various components
|
||||
such as dependencies, properties, methods, traits, and interfaces, and then
|
||||
writes the extracted information to YAML files in a specified destination directory.
|
||||
"""
|
||||
|
||||
import os
|
||||
import re
|
||||
import yaml
|
||||
from typing import Dict, List, Any
|
||||
|
||||
def parse_php_file(file_path: str) -> Dict[str, Any]:
|
||||
"""
|
||||
Parse a PHP file and extract its components.
|
||||
|
||||
Args:
|
||||
file_path (str): Path to the PHP file.
|
||||
|
||||
Returns:
|
||||
Dict[str, Any]: A dictionary containing extracted information:
|
||||
- name: Name of the PHP file (without extension)
|
||||
- class_comment: Comment for the class (if any)
|
||||
- dependencies: List of dependencies (use statements)
|
||||
- properties: List of class properties
|
||||
- methods: List of class methods
|
||||
- traits: List of traits used
|
||||
- interfaces: List of interfaces implemented
|
||||
"""
|
||||
with open(file_path, 'r') as file:
|
||||
content = file.read()
|
||||
|
||||
name = os.path.basename(file_path).split('.')[0]
|
||||
class_comment = extract_class_comment(content)
|
||||
dependencies = extract_dependencies(content)
|
||||
properties = extract_properties(content)
|
||||
methods = extract_methods(content)
|
||||
traits = extract_traits(content)
|
||||
interfaces = extract_interfaces(content)
|
||||
|
||||
return {
|
||||
"name": name,
|
||||
"class_comment": class_comment,
|
||||
"dependencies": dependencies,
|
||||
"properties": properties,
|
||||
"methods": methods,
|
||||
"traits": traits,
|
||||
"interfaces": interfaces
|
||||
}
|
||||
|
||||
def extract_class_comment(content: str) -> str:
|
||||
"""
|
||||
Extract the class-level comment from PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
str: Extracted class comment or empty string if not found.
|
||||
"""
|
||||
class_comment_pattern = r'/\*\*(.*?)\*/\s*class'
|
||||
match = re.search(class_comment_pattern, content, re.DOTALL)
|
||||
if match:
|
||||
return match.group(1).strip()
|
||||
return ""
|
||||
|
||||
def extract_dependencies(content: str) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Extract dependencies (use statements) from PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[Dict[str, str]]: List of dictionaries containing dependency information:
|
||||
- name: Alias or class name
|
||||
- type: Always "class" for now (might need refinement)
|
||||
- source: Full namespace of the dependency
|
||||
"""
|
||||
# Regex pattern to match use statements, capturing the full namespace and optional alias
|
||||
use_statements = re.findall(r'use\s+([\w\\]+)(?:\s+as\s+(\w+))?;', content)
|
||||
dependencies = []
|
||||
for use in use_statements:
|
||||
dep = {
|
||||
"name": use[1] if use[1] else use[0].split('\\')[-1],
|
||||
"type": "class", # Assuming class for now, might need refinement
|
||||
"source": use[0]
|
||||
}
|
||||
dependencies.append(dep)
|
||||
return dependencies
|
||||
|
||||
def extract_properties(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract class properties and their comments from PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[Dict[str, Any]]: List of dictionaries containing property information:
|
||||
- name: Property name (without $)
|
||||
- visibility: public, protected, or private
|
||||
- comment: Property comment (if any)
|
||||
"""
|
||||
# Regex pattern to match property declarations with optional comments
|
||||
property_pattern = r'(?:/\*\*(.*?)\*/\s*)?(public|protected|private)\s+(?:static\s+)?(\$\w+)(?:\s*=\s*[^;]+)?;'
|
||||
properties = re.findall(property_pattern, content, re.DOTALL)
|
||||
return [
|
||||
{
|
||||
"name": prop[2][1:],
|
||||
"visibility": prop[1],
|
||||
"comment": prop[0].strip() if prop[0] else None
|
||||
} for prop in properties
|
||||
]
|
||||
|
||||
def extract_methods(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract class methods and their comments from PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[Dict[str, Any]]: List of dictionaries containing method information:
|
||||
- name: Method name
|
||||
- visibility: public, protected, or private
|
||||
- parameters: List of parameter dictionaries
|
||||
- comment: Method comment (if any)
|
||||
"""
|
||||
# Regex pattern to match method declarations with optional comments
|
||||
method_pattern = r'(?:/\*\*(.*?)\*/\s*)?(public|protected|private)\s+(?:static\s+)?function\s+(\w+)\s*\((.*?)\)'
|
||||
methods = re.findall(method_pattern, content, re.DOTALL)
|
||||
parsed_methods = []
|
||||
for method in methods:
|
||||
parsed_methods.append({
|
||||
"name": method[2],
|
||||
"visibility": method[1],
|
||||
"parameters": parse_parameters(method[3]),
|
||||
"comment": method[0].strip() if method[0] else None
|
||||
})
|
||||
return parsed_methods
|
||||
|
||||
def parse_parameters(params_str: str) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Parse method parameters from a parameter string.
|
||||
|
||||
Args:
|
||||
params_str (str): String containing method parameters.
|
||||
|
||||
Returns:
|
||||
List[Dict[str, str]]: List of dictionaries containing parameter information:
|
||||
- name: Parameter name
|
||||
- default: Default value (if specified)
|
||||
"""
|
||||
params = params_str.split(',')
|
||||
parsed_params = []
|
||||
for param in params:
|
||||
param = param.strip()
|
||||
if param:
|
||||
parts = param.split('=')
|
||||
param_dict = {"name": parts[0].split()[-1].strip('$')}
|
||||
if len(parts) > 1:
|
||||
param_dict["default"] = parts[1].strip()
|
||||
parsed_params.append(param_dict)
|
||||
return parsed_params
|
||||
|
||||
def extract_traits(content: str) -> List[str]:
|
||||
"""
|
||||
Extract traits used in the PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[str]: List of trait names used in the class.
|
||||
"""
|
||||
return re.findall(r'use\s+([\w\\]+)(?:,\s*[\w\\]+)*;', content)
|
||||
|
||||
def extract_interfaces(content: str) -> List[str]:
|
||||
"""
|
||||
Extract interfaces implemented by the class in the PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[str]: List of interface names implemented by the class.
|
||||
"""
|
||||
return re.findall(r'implements\s+([\w\\]+)(?:,\s*[\w\\]+)*', content)
|
||||
|
||||
def convert_to_yaml(php_data: Dict[str, Any]) -> str:
|
||||
"""
|
||||
Convert extracted PHP data to YAML format.
|
||||
|
||||
Args:
|
||||
php_data (Dict[str, Any]): Dictionary containing extracted PHP data.
|
||||
|
||||
Returns:
|
||||
str: YAML representation of the PHP data.
|
||||
"""
|
||||
def format_comment(comment: str) -> str:
|
||||
return '\n'.join('# ' + line.strip() for line in comment.split('\n'))
|
||||
|
||||
formatted_data = {}
|
||||
for key, value in php_data.items():
|
||||
if key == 'class_comment':
|
||||
formatted_data['class_comment'] = format_comment(value) if value else None
|
||||
elif key == 'properties':
|
||||
formatted_data['properties'] = [
|
||||
{**prop, 'comment': format_comment(prop['comment']) if prop['comment'] else None}
|
||||
for prop in value
|
||||
]
|
||||
elif key == 'methods':
|
||||
formatted_data['methods'] = [
|
||||
{**method, 'comment': format_comment(method['comment']) if method.get('comment') else None}
|
||||
for method in value
|
||||
]
|
||||
else:
|
||||
formatted_data[key] = value
|
||||
|
||||
return yaml.dump(formatted_data, sort_keys=False, default_flow_style=False)
|
||||
|
||||
def process_directory(source_dir: str, dest_dir: str):
|
||||
"""
|
||||
Process all PHP files in the source directory and its subdirectories,
|
||||
extract information, and save as YAML files in the destination directory.
|
||||
|
||||
Args:
|
||||
source_dir (str): Path to the source directory containing PHP files.
|
||||
dest_dir (str): Path to the destination directory for YAML files.
|
||||
"""
|
||||
for root, dirs, files in os.walk(source_dir):
|
||||
for file in files:
|
||||
if file.endswith('.php'):
|
||||
source_path = os.path.join(root, file)
|
||||
relative_path = os.path.relpath(source_path, source_dir)
|
||||
dest_path = os.path.join(dest_dir, os.path.dirname(relative_path))
|
||||
|
||||
os.makedirs(dest_path, exist_ok=True)
|
||||
|
||||
php_data = parse_php_file(source_path)
|
||||
yaml_content = convert_to_yaml(php_data)
|
||||
|
||||
yaml_file = os.path.join(dest_path, f"{os.path.splitext(file)[0]}.yaml")
|
||||
with open(yaml_file, 'w') as f:
|
||||
f.write(yaml_content)
|
||||
|
||||
if __name__ == "__main__":
|
||||
source_directory = "/home/platform/Devboxes/resources/laravel_framework/src/Illuminate/"
|
||||
destination_directory = "/home/platform/Devboxes/platform/api/"
|
||||
|
||||
process_directory(source_directory, destination_directory)
|
||||
print("Extraction and conversion completed.")
|
||||
|
|
@ -1,165 +0,0 @@
|
|||
"""
|
||||
This script extracts information from Python files and converts it to YAML format.
|
||||
It processes Python files in a given source directory, extracts various components
|
||||
such as imports, classes, methods, and properties, and then writes the extracted
|
||||
information to YAML files in a specified destination directory.
|
||||
"""
|
||||
import os
|
||||
import re
|
||||
import ast
|
||||
import yaml
|
||||
from typing import Dict, List, Any
|
||||
|
||||
def parse_python_file(file_path: str) -> Dict[str, Any]:
|
||||
"""
|
||||
Parse a Python file and extract its components.
|
||||
Args:
|
||||
file_path (str): Path to the Python file.
|
||||
Returns:
|
||||
Dict[str, Any]: A dictionary containing extracted information:
|
||||
- name: Name of the Python file (without extension)
|
||||
- class_comment: Comment for the class (if any)
|
||||
- imports: List of import statements
|
||||
- classes: List of class information
|
||||
"""
|
||||
with open(file_path, 'r') as file:
|
||||
content = file.read()
|
||||
|
||||
tree = ast.parse(content)
|
||||
name = os.path.basename(file_path).split('.')[0]
|
||||
imports = extract_imports(tree)
|
||||
classes = extract_classes(tree)
|
||||
|
||||
return {
|
||||
"name": name,
|
||||
"imports": imports,
|
||||
"classes": classes
|
||||
}
|
||||
|
||||
def extract_imports(tree: ast.AST) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Extract import statements from Python AST.
|
||||
Args:
|
||||
tree (ast.AST): Python abstract syntax tree.
|
||||
Returns:
|
||||
List[Dict[str, str]]: List of dictionaries containing import information:
|
||||
- name: Imported name
|
||||
- source: Module source
|
||||
"""
|
||||
imports = []
|
||||
for node in ast.walk(tree):
|
||||
if isinstance(node, ast.Import):
|
||||
for alias in node.names:
|
||||
imports.append({"name": alias.name, "source": alias.name})
|
||||
elif isinstance(node, ast.ImportFrom):
|
||||
module = node.module
|
||||
for alias in node.names:
|
||||
imports.append({"name": alias.name, "source": f"{module}.{alias.name}"})
|
||||
return imports
|
||||
|
||||
def extract_classes(tree: ast.AST) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract class information from Python AST.
|
||||
Args:
|
||||
tree (ast.AST): Python abstract syntax tree.
|
||||
Returns:
|
||||
List[Dict[str, Any]]: List of dictionaries containing class information:
|
||||
- name: Class name
|
||||
- comment: Class docstring (if any)
|
||||
- bases: List of base classes
|
||||
- methods: List of method information
|
||||
- properties: List of class properties
|
||||
"""
|
||||
classes = []
|
||||
for node in ast.walk(tree):
|
||||
if isinstance(node, ast.ClassDef):
|
||||
class_info = {
|
||||
"name": node.name,
|
||||
"comment": ast.get_docstring(node),
|
||||
"bases": [base.id for base in node.bases if isinstance(base, ast.Name)],
|
||||
"methods": extract_methods(node),
|
||||
"properties": extract_properties(node)
|
||||
}
|
||||
classes.append(class_info)
|
||||
return classes
|
||||
|
||||
def extract_methods(class_node: ast.ClassDef) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract method information from a class node.
|
||||
Args:
|
||||
class_node (ast.ClassDef): Class definition node.
|
||||
Returns:
|
||||
List[Dict[str, Any]]: List of dictionaries containing method information:
|
||||
- name: Method name
|
||||
- comment: Method docstring (if any)
|
||||
- parameters: List of parameter names
|
||||
"""
|
||||
methods = []
|
||||
for node in class_node.body:
|
||||
if isinstance(node, ast.FunctionDef):
|
||||
method_info = {
|
||||
"name": node.name,
|
||||
"comment": ast.get_docstring(node),
|
||||
"parameters": [arg.arg for arg in node.args.args if arg.arg != 'self']
|
||||
}
|
||||
methods.append(method_info)
|
||||
return methods
|
||||
|
||||
def extract_properties(class_node: ast.ClassDef) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Extract property information from a class node.
|
||||
Args:
|
||||
class_node (ast.ClassDef): Class definition node.
|
||||
Returns:
|
||||
List[Dict[str, str]]: List of dictionaries containing property information:
|
||||
- name: Property name
|
||||
- type: Property type (if annotated)
|
||||
"""
|
||||
properties = []
|
||||
for node in class_node.body:
|
||||
if isinstance(node, ast.AnnAssign) and isinstance(node.target, ast.Name):
|
||||
prop_info = {
|
||||
"name": node.target.id,
|
||||
"type": ast.unparse(node.annotation) if node.annotation else None
|
||||
}
|
||||
properties.append(prop_info)
|
||||
return properties
|
||||
|
||||
def convert_to_yaml(python_data: Dict[str, Any]) -> str:
|
||||
"""
|
||||
Convert extracted Python data to YAML format.
|
||||
Args:
|
||||
python_data (Dict[str, Any]): Dictionary containing extracted Python data.
|
||||
Returns:
|
||||
str: YAML representation of the Python data.
|
||||
"""
|
||||
return yaml.dump(python_data, sort_keys=False, default_flow_style=False)
|
||||
|
||||
def process_directory(source_dir: str, dest_dir: str):
|
||||
"""
|
||||
Process all Python files in the source directory and its subdirectories,
|
||||
extract information, and save as YAML files in the destination directory.
|
||||
Args:
|
||||
source_dir (str): Path to the source directory containing Python files.
|
||||
dest_dir (str): Path to the destination directory for YAML files.
|
||||
"""
|
||||
for root, dirs, files in os.walk(source_dir):
|
||||
for file in files:
|
||||
if file.endswith('.py'):
|
||||
source_path = os.path.join(root, file)
|
||||
relative_path = os.path.relpath(source_path, source_dir)
|
||||
dest_path = os.path.join(dest_dir, os.path.dirname(relative_path))
|
||||
os.makedirs(dest_path, exist_ok=True)
|
||||
|
||||
python_data = parse_python_file(source_path)
|
||||
yaml_content = convert_to_yaml(python_data)
|
||||
|
||||
yaml_file = os.path.join(dest_path, f"{os.path.splitext(file)[0]}.yaml")
|
||||
with open(yaml_file, 'w') as f:
|
||||
f.write(yaml_content)
|
||||
|
||||
if __name__ == "__main__":
|
||||
source_directory = "/path/to/python/source/directory"
|
||||
destination_directory = "/path/to/yaml/destination/directory"
|
||||
process_directory(source_directory, destination_directory)
|
||||
print("Extraction and conversion completed.")
|
||||
|
|
@ -1,215 +0,0 @@
|
|||
"""
|
||||
This script extracts information from Rust files and converts it to YAML format.
|
||||
It processes Rust files in a given source directory, extracts various components
|
||||
such as dependencies, structs, impl blocks, traits, and functions, and then
|
||||
writes the extracted information to YAML files in a specified destination directory.
|
||||
"""
|
||||
import os
|
||||
import re
|
||||
import yaml
|
||||
from typing import Dict, List, Any
|
||||
|
||||
def parse_rust_file(file_path: str) -> Dict[str, Any]:
|
||||
"""
|
||||
Parse a Rust file and extract its components.
|
||||
Args:
|
||||
file_path (str): Path to the Rust file.
|
||||
Returns:
|
||||
Dict[str, Any]: A dictionary containing extracted information:
|
||||
- name: Name of the Rust file (without extension)
|
||||
- module_comment: Comment for the module (if any)
|
||||
- dependencies: List of dependencies (use statements)
|
||||
- structs: List of struct definitions
|
||||
- impls: List of impl blocks
|
||||
- traits: List of trait definitions
|
||||
- functions: List of standalone functions
|
||||
"""
|
||||
with open(file_path, 'r') as file:
|
||||
content = file.read()
|
||||
|
||||
name = os.path.basename(file_path).split('.')[0]
|
||||
module_comment = extract_module_comment(content)
|
||||
dependencies = extract_dependencies(content)
|
||||
structs = extract_structs(content)
|
||||
impls = extract_impls(content)
|
||||
traits = extract_traits(content)
|
||||
functions = extract_functions(content)
|
||||
|
||||
return {
|
||||
"name": name,
|
||||
"module_comment": module_comment,
|
||||
"dependencies": dependencies,
|
||||
"structs": structs,
|
||||
"impls": impls,
|
||||
"traits": traits,
|
||||
"functions": functions
|
||||
}
|
||||
|
||||
def extract_module_comment(content: str) -> str:
|
||||
"""
|
||||
Extract the module-level comment from Rust content.
|
||||
"""
|
||||
module_comment_pattern = r'^//!(.+?)(?=\n\S)'
|
||||
match = re.search(module_comment_pattern, content, re.DOTALL | re.MULTILINE)
|
||||
return match.group(1).strip() if match else ""
|
||||
|
||||
def extract_dependencies(content: str) -> List[str]:
|
||||
"""
|
||||
Extract dependencies (use statements) from Rust content.
|
||||
"""
|
||||
return re.findall(r'use\s+([\w:]+)(?:::\{.*?\})?;', content)
|
||||
|
||||
def extract_structs(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract struct definitions from Rust content.
|
||||
"""
|
||||
struct_pattern = r'///(.+?)?\n\s*pub struct (\w+)(?:<.*?>)?\s*\{([^}]+)\}'
|
||||
structs = re.findall(struct_pattern, content, re.DOTALL)
|
||||
return [
|
||||
{
|
||||
"name": struct[1],
|
||||
"comment": struct[0].strip() if struct[0] else None,
|
||||
"fields": extract_struct_fields(struct[2])
|
||||
} for struct in structs
|
||||
]
|
||||
|
||||
def extract_struct_fields(fields_str: str) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Extract fields from a struct definition.
|
||||
"""
|
||||
field_pattern = r'pub (\w+):\s*(.+)'
|
||||
return [
|
||||
{"name": field[0], "type": field[1].strip()}
|
||||
for field in re.findall(field_pattern, fields_str)
|
||||
]
|
||||
|
||||
def extract_impls(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract impl blocks from Rust content.
|
||||
"""
|
||||
impl_pattern = r'impl(?:<.*?>)?\s+(\w+)\s*(?:for\s+(\w+))?\s*\{([^}]+)\}'
|
||||
impls = re.findall(impl_pattern, content, re.DOTALL)
|
||||
return [
|
||||
{
|
||||
"struct": impl[0],
|
||||
"trait": impl[1] if impl[1] else None,
|
||||
"methods": extract_methods(impl[2])
|
||||
} for impl in impls
|
||||
]
|
||||
|
||||
def extract_methods(impl_content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract methods from an impl block.
|
||||
"""
|
||||
method_pattern = r'///(.+?)?\n\s*pub fn (\w+)\s*\(([^)]*)\)(?:\s*->\s*([^{]+))?\s*\{'
|
||||
methods = re.findall(method_pattern, impl_content, re.DOTALL)
|
||||
return [
|
||||
{
|
||||
"name": method[1],
|
||||
"comment": method[0].strip() if method[0] else None,
|
||||
"parameters": parse_parameters(method[2]),
|
||||
"return_type": method[3].strip() if method[3] else None
|
||||
} for method in methods
|
||||
]
|
||||
|
||||
def parse_parameters(params_str: str) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Parse method parameters from a parameter string.
|
||||
"""
|
||||
params = params_str.split(',')
|
||||
parsed_params = []
|
||||
for param in params:
|
||||
param = param.strip()
|
||||
if param:
|
||||
parts = param.split(':')
|
||||
parsed_params.append({"name": parts[0].strip(), "type": parts[1].strip()})
|
||||
return parsed_params
|
||||
|
||||
def extract_traits(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract trait definitions from Rust content.
|
||||
"""
|
||||
trait_pattern = r'pub trait (\w+)(?:<.*?>)?\s*\{([^}]+)\}'
|
||||
traits = re.findall(trait_pattern, content, re.DOTALL)
|
||||
return [
|
||||
{
|
||||
"name": trait[0],
|
||||
"methods": extract_trait_methods(trait[1])
|
||||
} for trait in traits
|
||||
]
|
||||
|
||||
def extract_trait_methods(trait_content: str) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Extract method signatures from a trait definition.
|
||||
"""
|
||||
method_pattern = r'fn (\w+)\s*\(([^)]*)\)(?:\s*->\s*([^;]+))?;'
|
||||
methods = re.findall(method_pattern, trait_content)
|
||||
return [
|
||||
{
|
||||
"name": method[0],
|
||||
"parameters": parse_parameters(method[1]),
|
||||
"return_type": method[2].strip() if method[2] else None
|
||||
} for method in methods
|
||||
]
|
||||
|
||||
def extract_functions(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract standalone functions from Rust content.
|
||||
"""
|
||||
function_pattern = r'///(.+?)?\n\s*pub fn (\w+)\s*\(([^)]*)\)(?:\s*->\s*([^{]+))?\s*\{'
|
||||
functions = re.findall(function_pattern, content, re.DOTALL)
|
||||
return [
|
||||
{
|
||||
"name": function[1],
|
||||
"comment": function[0].strip() if function[0] else None,
|
||||
"parameters": parse_parameters(function[2]),
|
||||
"return_type": function[3].strip() if function[3] else None
|
||||
} for function in functions
|
||||
]
|
||||
|
||||
def convert_to_yaml(rust_data: Dict[str, Any]) -> str:
|
||||
"""
|
||||
Convert extracted Rust data to YAML format.
|
||||
"""
|
||||
def format_comment(comment: str) -> str:
|
||||
return '\n'.join('# ' + line.strip() for line in comment.split('\n'))
|
||||
|
||||
formatted_data = {}
|
||||
for key, value in rust_data.items():
|
||||
if key == 'module_comment':
|
||||
formatted_data['module_comment'] = format_comment(value) if value else None
|
||||
elif key in ['structs', 'impls', 'traits', 'functions']:
|
||||
formatted_data[key] = [
|
||||
{**item, 'comment': format_comment(item['comment']) if item.get('comment') else None}
|
||||
for item in value
|
||||
]
|
||||
else:
|
||||
formatted_data[key] = value
|
||||
|
||||
return yaml.dump(formatted_data, sort_keys=False, default_flow_style=False)
|
||||
|
||||
def process_directory(source_dir: str, dest_dir: str):
|
||||
"""
|
||||
Process all Rust files in the source directory and its subdirectories,
|
||||
extract information, and save as YAML files in the destination directory.
|
||||
"""
|
||||
for root, dirs, files in os.walk(source_dir):
|
||||
for file in files:
|
||||
if file.endswith('.rs'):
|
||||
source_path = os.path.join(root, file)
|
||||
relative_path = os.path.relpath(source_path, source_dir)
|
||||
dest_path = os.path.join(dest_dir, os.path.dirname(relative_path))
|
||||
os.makedirs(dest_path, exist_ok=True)
|
||||
|
||||
rust_data = parse_rust_file(source_path)
|
||||
yaml_content = convert_to_yaml(rust_data)
|
||||
|
||||
yaml_file = os.path.join(dest_path, f"{os.path.splitext(file)[0]}.yaml")
|
||||
with open(yaml_file, 'w') as f:
|
||||
f.write(yaml_content)
|
||||
|
||||
if __name__ == "__main__":
|
||||
source_directory = "/path/to/rust/source/directory"
|
||||
destination_directory = "/path/to/yaml/destination/directory"
|
||||
process_directory(source_directory, destination_directory)
|
||||
print("Extraction and conversion completed.")
|
||||
|
|
@ -1,253 +0,0 @@
|
|||
"""
|
||||
This script extracts information from PHP files and converts it to YAML format.
|
||||
It processes PHP files in a given source directory, extracts various components
|
||||
such as dependencies, properties, methods, traits, and interfaces, and then
|
||||
writes the extracted information to YAML files in a specified destination directory.
|
||||
"""
|
||||
|
||||
import os
|
||||
import re
|
||||
import yaml
|
||||
from typing import Dict, List, Any
|
||||
|
||||
def parse_php_file(file_path: str) -> Dict[str, Any]:
|
||||
"""
|
||||
Parse a PHP file and extract its components.
|
||||
|
||||
Args:
|
||||
file_path (str): Path to the PHP file.
|
||||
|
||||
Returns:
|
||||
Dict[str, Any]: A dictionary containing extracted information:
|
||||
- name: Name of the PHP file (without extension)
|
||||
- class_comment: Comment for the class (if any)
|
||||
- dependencies: List of dependencies (use statements)
|
||||
- properties: List of class properties
|
||||
- methods: List of class methods
|
||||
- traits: List of traits used
|
||||
- interfaces: List of interfaces implemented
|
||||
"""
|
||||
with open(file_path, 'r') as file:
|
||||
content = file.read()
|
||||
|
||||
name = os.path.basename(file_path).split('.')[0]
|
||||
class_comment = extract_class_comment(content)
|
||||
dependencies = extract_dependencies(content)
|
||||
properties = extract_properties(content)
|
||||
methods = extract_methods(content)
|
||||
traits = extract_traits(content)
|
||||
interfaces = extract_interfaces(content)
|
||||
|
||||
return {
|
||||
"name": name,
|
||||
"class_comment": class_comment,
|
||||
"dependencies": dependencies,
|
||||
"properties": properties,
|
||||
"methods": methods,
|
||||
"traits": traits,
|
||||
"interfaces": interfaces
|
||||
}
|
||||
|
||||
def extract_class_comment(content: str) -> str:
|
||||
"""
|
||||
Extract the class-level comment from PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
str: Extracted class comment or empty string if not found.
|
||||
"""
|
||||
class_comment_pattern = r'/\*\*(.*?)\*/\s*class'
|
||||
match = re.search(class_comment_pattern, content, re.DOTALL)
|
||||
if match:
|
||||
return match.group(1).strip()
|
||||
return ""
|
||||
|
||||
def extract_dependencies(content: str) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Extract dependencies (use statements) from PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[Dict[str, str]]: List of dictionaries containing dependency information:
|
||||
- name: Alias or class name
|
||||
- type: Always "class" for now (might need refinement)
|
||||
- source: Full namespace of the dependency
|
||||
"""
|
||||
# Regex pattern to match use statements, capturing the full namespace and optional alias
|
||||
use_statements = re.findall(r'use\s+([\w\\]+)(?:\s+as\s+(\w+))?;', content)
|
||||
dependencies = []
|
||||
for use in use_statements:
|
||||
dep = {
|
||||
"name": use[1] if use[1] else use[0].split('\\')[-1],
|
||||
"type": "class", # Assuming class for now, might need refinement
|
||||
"source": use[0]
|
||||
}
|
||||
dependencies.append(dep)
|
||||
return dependencies
|
||||
|
||||
def extract_properties(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract class properties and their comments from PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[Dict[str, Any]]: List of dictionaries containing property information:
|
||||
- name: Property name (without $)
|
||||
- visibility: public, protected, or private
|
||||
- comment: Property comment (if any)
|
||||
"""
|
||||
# Regex pattern to match property declarations with optional comments
|
||||
property_pattern = r'(?:/\*\*(.*?)\*/\s*)?(public|protected|private)\s+(?:static\s+)?(\$\w+)(?:\s*=\s*[^;]+)?;'
|
||||
properties = re.findall(property_pattern, content, re.DOTALL)
|
||||
return [
|
||||
{
|
||||
"name": prop[2][1:],
|
||||
"visibility": prop[1],
|
||||
"comment": prop[0].strip() if prop[0] else None
|
||||
} for prop in properties
|
||||
]
|
||||
|
||||
def extract_methods(content: str) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Extract class methods and their comments from PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[Dict[str, Any]]: List of dictionaries containing method information:
|
||||
- name: Method name
|
||||
- visibility: public, protected, or private
|
||||
- parameters: List of parameter dictionaries
|
||||
- comment: Method comment (if any)
|
||||
"""
|
||||
# Regex pattern to match method declarations with optional comments
|
||||
method_pattern = r'(?:/\*\*(.*?)\*/\s*)?(public|protected|private)\s+(?:static\s+)?function\s+(\w+)\s*\((.*?)\)'
|
||||
methods = re.findall(method_pattern, content, re.DOTALL)
|
||||
parsed_methods = []
|
||||
for method in methods:
|
||||
parsed_methods.append({
|
||||
"name": method[2],
|
||||
"visibility": method[1],
|
||||
"parameters": parse_parameters(method[3]),
|
||||
"comment": method[0].strip() if method[0] else None
|
||||
})
|
||||
return parsed_methods
|
||||
|
||||
def parse_parameters(params_str: str) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Parse method parameters from a parameter string.
|
||||
|
||||
Args:
|
||||
params_str (str): String containing method parameters.
|
||||
|
||||
Returns:
|
||||
List[Dict[str, str]]: List of dictionaries containing parameter information:
|
||||
- name: Parameter name
|
||||
- default: Default value (if specified)
|
||||
"""
|
||||
params = params_str.split(',')
|
||||
parsed_params = []
|
||||
for param in params:
|
||||
param = param.strip()
|
||||
if param:
|
||||
parts = param.split('=')
|
||||
param_dict = {"name": parts[0].split()[-1].strip('$')}
|
||||
if len(parts) > 1:
|
||||
param_dict["default"] = parts[1].strip()
|
||||
parsed_params.append(param_dict)
|
||||
return parsed_params
|
||||
|
||||
def extract_traits(content: str) -> List[str]:
|
||||
"""
|
||||
Extract traits used in the PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[str]: List of trait names used in the class.
|
||||
"""
|
||||
return re.findall(r'use\s+([\w\\]+)(?:,\s*[\w\\]+)*;', content)
|
||||
|
||||
def extract_interfaces(content: str) -> List[str]:
|
||||
"""
|
||||
Extract interfaces implemented by the class in the PHP content.
|
||||
|
||||
Args:
|
||||
content (str): PHP file content.
|
||||
|
||||
Returns:
|
||||
List[str]: List of interface names implemented by the class.
|
||||
"""
|
||||
return re.findall(r'implements\s+([\w\\]+)(?:,\s*[\w\\]+)*', content)
|
||||
|
||||
def convert_to_yaml(php_data: Dict[str, Any]) -> str:
|
||||
"""
|
||||
Convert extracted PHP data to YAML format.
|
||||
|
||||
Args:
|
||||
php_data (Dict[str, Any]): Dictionary containing extracted PHP data.
|
||||
|
||||
Returns:
|
||||
str: YAML representation of the PHP data.
|
||||
"""
|
||||
def format_comment(comment: str) -> str:
|
||||
return '\n'.join('# ' + line.strip() for line in comment.split('\n'))
|
||||
|
||||
formatted_data = {}
|
||||
for key, value in php_data.items():
|
||||
if key == 'class_comment':
|
||||
formatted_data['class_comment'] = format_comment(value) if value else None
|
||||
elif key == 'properties':
|
||||
formatted_data['properties'] = [
|
||||
{**prop, 'comment': format_comment(prop['comment']) if prop['comment'] else None}
|
||||
for prop in value
|
||||
]
|
||||
elif key == 'methods':
|
||||
formatted_data['methods'] = [
|
||||
{**method, 'comment': format_comment(method['comment']) if method.get('comment') else None}
|
||||
for method in value
|
||||
]
|
||||
else:
|
||||
formatted_data[key] = value
|
||||
|
||||
return yaml.dump(formatted_data, sort_keys=False, default_flow_style=False)
|
||||
|
||||
def process_directory(source_dir: str, dest_dir: str):
|
||||
"""
|
||||
Process all PHP files in the source directory and its subdirectories,
|
||||
extract information, and save as YAML files in the destination directory.
|
||||
|
||||
Args:
|
||||
source_dir (str): Path to the source directory containing PHP files.
|
||||
dest_dir (str): Path to the destination directory for YAML files.
|
||||
"""
|
||||
for root, dirs, files in os.walk(source_dir):
|
||||
for file in files:
|
||||
if file.endswith('.php'):
|
||||
source_path = os.path.join(root, file)
|
||||
relative_path = os.path.relpath(source_path, source_dir)
|
||||
dest_path = os.path.join(dest_dir, os.path.dirname(relative_path))
|
||||
|
||||
os.makedirs(dest_path, exist_ok=True)
|
||||
|
||||
php_data = parse_php_file(source_path)
|
||||
yaml_content = convert_to_yaml(php_data)
|
||||
|
||||
yaml_file = os.path.join(dest_path, f"{os.path.splitext(file)[0]}.yaml")
|
||||
with open(yaml_file, 'w') as f:
|
||||
f.write(yaml_content)
|
||||
|
||||
if __name__ == "__main__":
|
||||
source_directory = "/home/platform/Devboxes/resources/symfony/src/Symfony/"
|
||||
destination_directory = "/home/platform/Devboxes/platform/api2/"
|
||||
|
||||
process_directory(source_directory, destination_directory)
|
||||
print("Extraction and conversion completed.")
|
||||
|
|
@ -1,191 +0,0 @@
|
|||
/**
|
||||
* This script extracts information from TypeScript files and converts it to YAML format.
|
||||
* It processes TypeScript files in a given source directory, extracts various components
|
||||
* such as imports, classes, methods, and properties, and then writes the extracted
|
||||
* information to YAML files in a specified destination directory.
|
||||
*/
|
||||
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
import * as ts from 'typescript';
|
||||
import * as yaml from 'js-yaml';
|
||||
|
||||
interface FileData {
|
||||
name: string;
|
||||
imports: Import[];
|
||||
classes: ClassInfo[];
|
||||
}
|
||||
|
||||
interface Import {
|
||||
name: string;
|
||||
source: string;
|
||||
}
|
||||
|
||||
interface ClassInfo {
|
||||
name: string;
|
||||
comment?: string;
|
||||
extends?: string[];
|
||||
implements?: string[];
|
||||
methods: MethodInfo[];
|
||||
properties: PropertyInfo[];
|
||||
}
|
||||
|
||||
interface MethodInfo {
|
||||
name: string;
|
||||
comment?: string;
|
||||
parameters: ParameterInfo[];
|
||||
returnType?: string;
|
||||
}
|
||||
|
||||
interface ParameterInfo {
|
||||
name: string;
|
||||
type?: string;
|
||||
}
|
||||
|
||||
interface PropertyInfo {
|
||||
name: string;
|
||||
type?: string;
|
||||
visibility: string;
|
||||
}
|
||||
|
||||
function parseTypeScriptFile(filePath: string): FileData {
|
||||
const content = fs.readFileSync(filePath, 'utf-8');
|
||||
const sourceFile = ts.createSourceFile(filePath, content, ts.ScriptTarget.Latest, true);
|
||||
|
||||
const name = path.basename(filePath).split('.')[0];
|
||||
const imports = extractImports(sourceFile);
|
||||
const classes = extractClasses(sourceFile);
|
||||
|
||||
return { name, imports, classes };
|
||||
}
|
||||
|
||||
function extractImports(sourceFile: ts.SourceFile): Import[] {
|
||||
const imports: Import[] = [];
|
||||
|
||||
ts.forEachChild(sourceFile, node => {
|
||||
if (ts.isImportDeclaration(node)) {
|
||||
const importClause = node.importClause;
|
||||
const moduleSpecifier = node.moduleSpecifier;
|
||||
|
||||
if (importClause && ts.isStringLiteral(moduleSpecifier)) {
|
||||
const name = importClause.name?.text ?? '*';
|
||||
const source = moduleSpecifier.text;
|
||||
imports.push({ name, source });
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
return imports;
|
||||
}
|
||||
|
||||
function extractClasses(sourceFile: ts.SourceFile): ClassInfo[] {
|
||||
const classes: ClassInfo[] = [];
|
||||
|
||||
ts.forEachChild(sourceFile, node => {
|
||||
if (ts.isClassDeclaration(node) && node.name) {
|
||||
const classInfo: ClassInfo = {
|
||||
name: node.name.text,
|
||||
comment: getLeadingCommentText(node),
|
||||
extends: node.heritageClauses?.filter(clause => clause.token === ts.SyntaxKind.ExtendsKeyword)
|
||||
.flatMap(clause => clause.types.map(t => t.getText())),
|
||||
implements: node.heritageClauses?.filter(clause => clause.token === ts.SyntaxKind.ImplementsKeyword)
|
||||
.flatMap(clause => clause.types.map(t => t.getText())),
|
||||
methods: extractMethods(node),
|
||||
properties: extractProperties(node)
|
||||
};
|
||||
classes.push(classInfo);
|
||||
}
|
||||
});
|
||||
|
||||
return classes;
|
||||
}
|
||||
|
||||
function extractMethods(classNode: ts.ClassDeclaration): MethodInfo[] {
|
||||
const methods: MethodInfo[] = [];
|
||||
|
||||
classNode.members.forEach(member => {
|
||||
if (ts.isMethodDeclaration(member) && member.name) {
|
||||
const methodInfo: MethodInfo = {
|
||||
name: member.name.getText(),
|
||||
comment: getLeadingCommentText(member),
|
||||
parameters: extractParameters(member),
|
||||
returnType: member.type ? member.type.getText() : undefined
|
||||
};
|
||||
methods.push(methodInfo);
|
||||
}
|
||||
});
|
||||
|
||||
return methods;
|
||||
}
|
||||
|
||||
function extractParameters(method: ts.MethodDeclaration): ParameterInfo[] {
|
||||
return method.parameters.map(param => ({
|
||||
name: param.name.getText(),
|
||||
type: param.type ? param.type.getText() : undefined
|
||||
}));
|
||||
}
|
||||
|
||||
function extractProperties(classNode: ts.ClassDeclaration): PropertyInfo[] {
|
||||
const properties: PropertyInfo[] = [];
|
||||
|
||||
classNode.members.forEach(member => {
|
||||
if (ts.isPropertyDeclaration(member) && member.name) {
|
||||
const propertyInfo: PropertyInfo = {
|
||||
name: member.name.getText(),
|
||||
type: member.type ? member.type.getText() : undefined,
|
||||
visibility: getVisibility(member)
|
||||
};
|
||||
properties.push(propertyInfo);
|
||||
}
|
||||
});
|
||||
|
||||
return properties;
|
||||
}
|
||||
|
||||
function getVisibility(node: ts.Node): string {
|
||||
if (node.modifiers) {
|
||||
if (node.modifiers.some(m => m.kind === ts.SyntaxKind.PrivateKeyword)) return 'private';
|
||||
if (node.modifiers.some(m => m.kind === ts.SyntaxKind.ProtectedKeyword)) return 'protected';
|
||||
if (node.modifiers.some(m => m.kind === ts.SyntaxKind.PublicKeyword)) return 'public';
|
||||
}
|
||||
return 'public'; // Default visibility in TypeScript
|
||||
}
|
||||
|
||||
function getLeadingCommentText(node: ts.Node): string | undefined {
|
||||
const fullText = node.getFullText();
|
||||
const trivia = fullText.substring(0, node.getLeadingTriviaWidth());
|
||||
const commentRanges = ts.getLeadingCommentRanges(trivia, 0);
|
||||
|
||||
if (commentRanges && commentRanges.length > 0) {
|
||||
return trivia.substring(commentRanges[0].pos, commentRanges[0].end).trim();
|
||||
}
|
||||
|
||||
return undefined;
|
||||
}
|
||||
|
||||
function convertToYaml(data: FileData): string {
|
||||
return yaml.dump(data, { sortKeys: false });
|
||||
}
|
||||
|
||||
function processDirectory(sourceDir: string, destDir: string): void {
|
||||
fs.readdirSync(sourceDir, { withFileTypes: true }).forEach(entry => {
|
||||
const sourcePath = path.join(sourceDir, entry.name);
|
||||
const destPath = path.join(destDir, entry.name);
|
||||
|
||||
if (entry.isDirectory()) {
|
||||
fs.mkdirSync(destPath, { recursive: true });
|
||||
processDirectory(sourcePath, destPath);
|
||||
} else if (entry.isFile() && entry.name.endsWith('.ts')) {
|
||||
const tsData = parseTypeScriptFile(sourcePath);
|
||||
const yamlContent = convertToYaml(tsData);
|
||||
const yamlPath = path.join(destDir, `${path.parse(entry.name).name}.yaml`);
|
||||
fs.writeFileSync(yamlPath, yamlContent);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
const sourceDirectory = '/path/to/typescript/source/directory';
|
||||
const destinationDirectory = '/path/to/yaml/destination/directory';
|
||||
|
||||
processDirectory(sourceDirectory, destinationDirectory);
|
||||
console.log('Extraction and conversion completed.');
|
||||
|
|
@ -1,106 +0,0 @@
|
|||
name: AuthorizationException
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Exception
|
||||
type: class
|
||||
source: Exception
|
||||
- name: Throwable
|
||||
type: class
|
||||
source: Throwable
|
||||
properties:
|
||||
- name: response
|
||||
visibility: protected
|
||||
comment: '# * The response from the gate.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Auth\Access\Response'
|
||||
- name: status
|
||||
visibility: protected
|
||||
comment: '# * The HTTP response status code.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int|null'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: message
|
||||
default: 'null'
|
||||
- name: code
|
||||
default: 'null'
|
||||
- name: previous
|
||||
default: 'null'
|
||||
comment: "# * The response from the gate.\n# *\n# * @var \\Illuminate\\Auth\\Access\\\
|
||||
Response\n# */\n# protected $response;\n# \n# /**\n# * The HTTP response status\
|
||||
\ code.\n# *\n# * @var int|null\n# */\n# protected $status;\n# \n# /**\n# * Create\
|
||||
\ a new authorization exception instance.\n# *\n# * @param string|null $message\n\
|
||||
# * @param mixed $code\n# * @param \\Throwable|null $previous\n# * @return\
|
||||
\ void"
|
||||
- name: response
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the response from the gate.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response'
|
||||
- name: setResponse
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: response
|
||||
comment: '# * Set the response from the gate.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Auth\Access\Response $response
|
||||
|
||||
# * @return $this'
|
||||
- name: withStatus
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: status
|
||||
comment: '# * Set the HTTP response status code.
|
||||
|
||||
# *
|
||||
|
||||
# * @param int|null $status
|
||||
|
||||
# * @return $this'
|
||||
- name: asNotFound
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Set the HTTP response status code to 404.
|
||||
|
||||
# *
|
||||
|
||||
# * @return $this'
|
||||
- name: hasStatus
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the HTTP status code has been set.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: status
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the HTTP status code.
|
||||
|
||||
# *
|
||||
|
||||
# * @return int|null'
|
||||
- name: toResponse
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Create a deny response object from this exception.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response'
|
||||
traits:
|
||||
- Exception
|
||||
- Throwable
|
||||
interfaces: []
|
||||
|
|
@ -1,51 +0,0 @@
|
|||
name: GateEvaluated
|
||||
class_comment: null
|
||||
dependencies: []
|
||||
properties:
|
||||
- name: user
|
||||
visibility: public
|
||||
comment: '# * The authenticatable model.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\Authenticatable|null'
|
||||
- name: ability
|
||||
visibility: public
|
||||
comment: '# * The ability being evaluated.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: result
|
||||
visibility: public
|
||||
comment: '# * The result of the evaluation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var bool|null'
|
||||
- name: arguments
|
||||
visibility: public
|
||||
comment: '# * The arguments given during evaluation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
- name: ability
|
||||
- name: result
|
||||
- name: arguments
|
||||
comment: "# * The authenticatable model.\n# *\n# * @var \\Illuminate\\Contracts\\\
|
||||
Auth\\Authenticatable|null\n# */\n# public $user;\n# \n# /**\n# * The ability\
|
||||
\ being evaluated.\n# *\n# * @var string\n# */\n# public $ability;\n# \n# /**\n\
|
||||
# * The result of the evaluation.\n# *\n# * @var bool|null\n# */\n# public $result;\n\
|
||||
# \n# /**\n# * The arguments given during evaluation.\n# *\n# * @var array\n#\
|
||||
\ */\n# public $arguments;\n# \n# /**\n# * Create a new event instance.\n# *\n\
|
||||
# * @param \\Illuminate\\Contracts\\Auth\\Authenticatable|null $user\n# * @param\
|
||||
\ string $ability\n# * @param bool|null $result\n# * @param array $arguments\n\
|
||||
# * @return void"
|
||||
traits: []
|
||||
interfaces: []
|
||||
|
|
@ -1,784 +0,0 @@
|
|||
name: Gate
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: Exception
|
||||
type: class
|
||||
source: Exception
|
||||
- name: GateEvaluated
|
||||
type: class
|
||||
source: Illuminate\Auth\Access\Events\GateEvaluated
|
||||
- name: GateContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Access\Gate
|
||||
- name: Container
|
||||
type: class
|
||||
source: Illuminate\Contracts\Container\Container
|
||||
- name: Dispatcher
|
||||
type: class
|
||||
source: Illuminate\Contracts\Events\Dispatcher
|
||||
- name: Arr
|
||||
type: class
|
||||
source: Illuminate\Support\Arr
|
||||
- name: Collection
|
||||
type: class
|
||||
source: Illuminate\Support\Collection
|
||||
- name: Str
|
||||
type: class
|
||||
source: Illuminate\Support\Str
|
||||
- name: InvalidArgumentException
|
||||
type: class
|
||||
source: InvalidArgumentException
|
||||
- name: ReflectionClass
|
||||
type: class
|
||||
source: ReflectionClass
|
||||
- name: ReflectionFunction
|
||||
type: class
|
||||
source: ReflectionFunction
|
||||
- name: HandlesAuthorization
|
||||
type: class
|
||||
source: HandlesAuthorization
|
||||
properties:
|
||||
- name: container
|
||||
visibility: protected
|
||||
comment: '# * The container instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Container\Container'
|
||||
- name: userResolver
|
||||
visibility: protected
|
||||
comment: '# * The user resolver callable.
|
||||
|
||||
# *
|
||||
|
||||
# * @var callable'
|
||||
- name: abilities
|
||||
visibility: protected
|
||||
comment: '# * All of the defined abilities.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: policies
|
||||
visibility: protected
|
||||
comment: '# * All of the defined policies.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: beforeCallbacks
|
||||
visibility: protected
|
||||
comment: '# * All of the registered before callbacks.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: afterCallbacks
|
||||
visibility: protected
|
||||
comment: '# * All of the registered after callbacks.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: stringCallbacks
|
||||
visibility: protected
|
||||
comment: '# * All of the defined abilities using class@method notation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: defaultDenialResponse
|
||||
visibility: protected
|
||||
comment: '# * The default denial response for gates and policies.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Auth\Access\Response|null'
|
||||
- name: guessPolicyNamesUsingCallback
|
||||
visibility: protected
|
||||
comment: '# * The callback to be used to guess policy names.
|
||||
|
||||
# *
|
||||
|
||||
# * @var callable|null'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: container
|
||||
- name: userResolver
|
||||
- name: abilities
|
||||
default: '[]'
|
||||
- name: policies
|
||||
default: '[]'
|
||||
- name: beforeCallbacks
|
||||
default: '[]'
|
||||
- name: afterCallbacks
|
||||
default: '[]'
|
||||
- name: guessPolicyNamesUsingCallback
|
||||
default: 'null'
|
||||
comment: "# * The container instance.\n# *\n# * @var \\Illuminate\\Contracts\\Container\\\
|
||||
Container\n# */\n# protected $container;\n# \n# /**\n# * The user resolver callable.\n\
|
||||
# *\n# * @var callable\n# */\n# protected $userResolver;\n# \n# /**\n# * All of\
|
||||
\ the defined abilities.\n# *\n# * @var array\n# */\n# protected $abilities =\
|
||||
\ [];\n# \n# /**\n# * All of the defined policies.\n# *\n# * @var array\n# */\n\
|
||||
# protected $policies = [];\n# \n# /**\n# * All of the registered before callbacks.\n\
|
||||
# *\n# * @var array\n# */\n# protected $beforeCallbacks = [];\n# \n# /**\n# *\
|
||||
\ All of the registered after callbacks.\n# *\n# * @var array\n# */\n# protected\
|
||||
\ $afterCallbacks = [];\n# \n# /**\n# * All of the defined abilities using class@method\
|
||||
\ notation.\n# *\n# * @var array\n# */\n# protected $stringCallbacks = [];\n#\
|
||||
\ \n# /**\n# * The default denial response for gates and policies.\n# *\n# * @var\
|
||||
\ \\Illuminate\\Auth\\Access\\Response|null\n# */\n# protected $defaultDenialResponse;\n\
|
||||
# \n# /**\n# * The callback to be used to guess policy names.\n# *\n# * @var callable|null\n\
|
||||
# */\n# protected $guessPolicyNamesUsingCallback;\n# \n# /**\n# * Create a new\
|
||||
\ gate instance.\n# *\n# * @param \\Illuminate\\Contracts\\Container\\Container\
|
||||
\ $container\n# * @param callable $userResolver\n# * @param array $abilities\n\
|
||||
# * @param array $policies\n# * @param array $beforeCallbacks\n# * @param\
|
||||
\ array $afterCallbacks\n# * @param callable|null $guessPolicyNamesUsingCallback\n\
|
||||
# * @return void"
|
||||
- name: has
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: ability
|
||||
comment: '# * Determine if a given ability has been defined.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|array $ability
|
||||
|
||||
# * @return bool'
|
||||
- name: allowIf
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: condition
|
||||
- name: message
|
||||
default: 'null'
|
||||
- name: code
|
||||
default: 'null'
|
||||
comment: '# * Perform an on-demand authorization check. Throw an authorization exception
|
||||
if the condition or callback is false.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Auth\Access\Response|\Closure|bool $condition
|
||||
|
||||
# * @param string|null $message
|
||||
|
||||
# * @param string|null $code
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Auth\Access\AuthorizationException'
|
||||
- name: denyIf
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: condition
|
||||
- name: message
|
||||
default: 'null'
|
||||
- name: code
|
||||
default: 'null'
|
||||
comment: '# * Perform an on-demand authorization check. Throw an authorization exception
|
||||
if the condition or callback is true.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Auth\Access\Response|\Closure|bool $condition
|
||||
|
||||
# * @param string|null $message
|
||||
|
||||
# * @param string|null $code
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Auth\Access\AuthorizationException'
|
||||
- name: authorizeOnDemand
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: condition
|
||||
- name: message
|
||||
- name: code
|
||||
- name: allowWhenResponseIs
|
||||
comment: '# * Authorize a given condition or callback.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Auth\Access\Response|\Closure|bool $condition
|
||||
|
||||
# * @param string|null $message
|
||||
|
||||
# * @param string|null $code
|
||||
|
||||
# * @param bool $allowWhenResponseIs
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Auth\Access\AuthorizationException'
|
||||
- name: define
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: ability
|
||||
- name: callback
|
||||
comment: '# * Define a new ability.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @param callable|array|string $callback
|
||||
|
||||
# * @return $this
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \InvalidArgumentException'
|
||||
- name: resource
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
- name: class
|
||||
- name: abilities
|
||||
default: 'null'
|
||||
comment: '# * Define abilities for a resource.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @param string $class
|
||||
|
||||
# * @param array|null $abilities
|
||||
|
||||
# * @return $this'
|
||||
- name: buildAbilityCallback
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: ability
|
||||
- name: callback
|
||||
comment: '# * Create the ability callback for a callback string.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @param string $callback
|
||||
|
||||
# * @return \Closure'
|
||||
- name: policy
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: class
|
||||
- name: policy
|
||||
comment: '# * Define a policy class for a given class type.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $class
|
||||
|
||||
# * @param string $policy
|
||||
|
||||
# * @return $this'
|
||||
- name: before
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Register a callback to run before all Gate checks.
|
||||
|
||||
# *
|
||||
|
||||
# * @param callable $callback
|
||||
|
||||
# * @return $this'
|
||||
- name: after
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Register a callback to run after all Gate checks.
|
||||
|
||||
# *
|
||||
|
||||
# * @param callable $callback
|
||||
|
||||
# * @return $this'
|
||||
- name: allows
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: ability
|
||||
- name: arguments
|
||||
default: '[]'
|
||||
comment: '# * Determine if all of the given abilities should be granted for the
|
||||
current user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param iterable|string $ability
|
||||
|
||||
# * @param array|mixed $arguments
|
||||
|
||||
# * @return bool'
|
||||
- name: denies
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: ability
|
||||
- name: arguments
|
||||
default: '[]'
|
||||
comment: '# * Determine if any of the given abilities should be denied for the current
|
||||
user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param iterable|string $ability
|
||||
|
||||
# * @param array|mixed $arguments
|
||||
|
||||
# * @return bool'
|
||||
- name: check
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: abilities
|
||||
- name: arguments
|
||||
default: '[]'
|
||||
comment: '# * Determine if all of the given abilities should be granted for the
|
||||
current user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param iterable|string $abilities
|
||||
|
||||
# * @param array|mixed $arguments
|
||||
|
||||
# * @return bool'
|
||||
- name: any
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: abilities
|
||||
- name: arguments
|
||||
default: '[]'
|
||||
comment: '# * Determine if any one of the given abilities should be granted for
|
||||
the current user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param iterable|string $abilities
|
||||
|
||||
# * @param array|mixed $arguments
|
||||
|
||||
# * @return bool'
|
||||
- name: none
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: abilities
|
||||
- name: arguments
|
||||
default: '[]'
|
||||
comment: '# * Determine if all of the given abilities should be denied for the current
|
||||
user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param iterable|string $abilities
|
||||
|
||||
# * @param array|mixed $arguments
|
||||
|
||||
# * @return bool'
|
||||
- name: authorize
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: ability
|
||||
- name: arguments
|
||||
default: '[]'
|
||||
comment: '# * Determine if the given ability should be granted for the current user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @param array|mixed $arguments
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Auth\Access\AuthorizationException'
|
||||
- name: inspect
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: ability
|
||||
- name: arguments
|
||||
default: '[]'
|
||||
comment: '# * Inspect the user for the given ability.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @param array|mixed $arguments
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response'
|
||||
- name: raw
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: ability
|
||||
- name: arguments
|
||||
default: '[]'
|
||||
comment: '# * Get the raw result from the authorization callback.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @param array|mixed $arguments
|
||||
|
||||
# * @return mixed
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Auth\Access\AuthorizationException'
|
||||
- name: canBeCalledWithUser
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
- name: class
|
||||
- name: method
|
||||
default: 'null'
|
||||
comment: '# * Determine whether the callback/method can be called with the given
|
||||
user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable|null $user
|
||||
|
||||
# * @param \Closure|string|array $class
|
||||
|
||||
# * @param string|null $method
|
||||
|
||||
# * @return bool'
|
||||
- name: methodAllowsGuests
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: class
|
||||
- name: method
|
||||
comment: '# * Determine if the given class method allows guests.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $class
|
||||
|
||||
# * @param string $method
|
||||
|
||||
# * @return bool'
|
||||
- name: callbackAllowsGuests
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Determine if the callback allows guests.
|
||||
|
||||
# *
|
||||
|
||||
# * @param callable $callback
|
||||
|
||||
# * @return bool
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \ReflectionException'
|
||||
- name: parameterAllowsGuests
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: parameter
|
||||
comment: '# * Determine if the given parameter allows guests.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \ReflectionParameter $parameter
|
||||
|
||||
# * @return bool'
|
||||
- name: callAuthCallback
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
- name: ability
|
||||
- name: arguments
|
||||
comment: '# * Resolve and call the appropriate authorization callback.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable|null $user
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @param array $arguments
|
||||
|
||||
# * @return bool'
|
||||
- name: callBeforeCallbacks
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
- name: ability
|
||||
- name: arguments
|
||||
comment: '# * Call all of the before callbacks and return if a result is given.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable|null $user
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @param array $arguments
|
||||
|
||||
# * @return bool|null'
|
||||
- name: callAfterCallbacks
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
- name: ability
|
||||
- name: arguments
|
||||
- name: result
|
||||
comment: '# * Call all of the after callbacks with check result.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @param array $arguments
|
||||
|
||||
# * @param bool $result
|
||||
|
||||
# * @return bool|null'
|
||||
- name: dispatchGateEvaluatedEvent
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
- name: ability
|
||||
- name: arguments
|
||||
- name: result
|
||||
comment: '# * Dispatch a gate evaluation event.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable|null $user
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @param array $arguments
|
||||
|
||||
# * @param bool|null $result
|
||||
|
||||
# * @return void'
|
||||
- name: resolveAuthCallback
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
- name: ability
|
||||
- name: arguments
|
||||
comment: '# * Resolve the callable for the given ability and arguments.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable|null $user
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @param array $arguments
|
||||
|
||||
# * @return callable'
|
||||
- name: getPolicyFor
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: class
|
||||
comment: '# * Get a policy instance for a given class.
|
||||
|
||||
# *
|
||||
|
||||
# * @param object|string $class
|
||||
|
||||
# * @return mixed'
|
||||
- name: guessPolicyName
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: class
|
||||
comment: '# * Guess the policy name for the given class.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $class
|
||||
|
||||
# * @return array'
|
||||
- name: guessPolicyNamesUsing
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Specify a callback to be used to guess policy names.
|
||||
|
||||
# *
|
||||
|
||||
# * @param callable $callback
|
||||
|
||||
# * @return $this'
|
||||
- name: resolvePolicy
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: class
|
||||
comment: '# * Build a policy class instance of the given type.
|
||||
|
||||
# *
|
||||
|
||||
# * @param object|string $class
|
||||
|
||||
# * @return mixed
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Contracts\Container\BindingResolutionException'
|
||||
- name: resolvePolicyCallback
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
- name: ability
|
||||
- name: arguments
|
||||
- name: policy
|
||||
comment: '# * Resolve the callback for a policy check.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @param array $arguments
|
||||
|
||||
# * @param mixed $policy
|
||||
|
||||
# * @return bool|callable'
|
||||
- name: callPolicyBefore
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: policy
|
||||
- name: user
|
||||
- name: ability
|
||||
- name: arguments
|
||||
comment: '# * Call the "before" method on the given policy, if applicable.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $policy
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @param array $arguments
|
||||
|
||||
# * @return mixed'
|
||||
- name: callPolicyMethod
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: policy
|
||||
- name: method
|
||||
- name: user
|
||||
- name: arguments
|
||||
comment: '# * Call the appropriate method on the given policy.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $policy
|
||||
|
||||
# * @param string $method
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable|null $user
|
||||
|
||||
# * @param array $arguments
|
||||
|
||||
# * @return mixed'
|
||||
- name: formatAbilityToMethod
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: ability
|
||||
comment: '# * Format the policy ability into a method name.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @return string'
|
||||
- name: forUser
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Get a gate instance for the given user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable|mixed $user
|
||||
|
||||
# * @return static'
|
||||
- name: resolveUser
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Resolve the user from the user resolver.
|
||||
|
||||
# *
|
||||
|
||||
# * @return mixed'
|
||||
- name: abilities
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get all of the defined abilities.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
- name: policies
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get all of the defined policies.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
- name: defaultDenialResponse
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: response
|
||||
comment: '# * Set the default denial response for gates and policies.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Auth\Access\Response $response
|
||||
|
||||
# * @return $this'
|
||||
- name: setContainer
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: container
|
||||
comment: '# * Set the container instance used by the gate.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Container\Container $container
|
||||
|
||||
# * @return $this'
|
||||
traits:
|
||||
- Closure
|
||||
- Exception
|
||||
- Illuminate\Auth\Access\Events\GateEvaluated
|
||||
- Illuminate\Contracts\Container\Container
|
||||
- Illuminate\Contracts\Events\Dispatcher
|
||||
- Illuminate\Support\Arr
|
||||
- Illuminate\Support\Collection
|
||||
- Illuminate\Support\Str
|
||||
- InvalidArgumentException
|
||||
- ReflectionClass
|
||||
- ReflectionFunction
|
||||
- HandlesAuthorization
|
||||
interfaces:
|
||||
- GateContract
|
||||
|
|
@ -1,74 +0,0 @@
|
|||
name: HandlesAuthorization
|
||||
class_comment: null
|
||||
dependencies: []
|
||||
properties: []
|
||||
methods:
|
||||
- name: allow
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: message
|
||||
default: 'null'
|
||||
- name: code
|
||||
default: 'null'
|
||||
comment: '# * Create a new access response.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $message
|
||||
|
||||
# * @param mixed $code
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response'
|
||||
- name: deny
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: message
|
||||
default: 'null'
|
||||
- name: code
|
||||
default: 'null'
|
||||
comment: '# * Throws an unauthorized exception.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $message
|
||||
|
||||
# * @param mixed|null $code
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response'
|
||||
- name: denyWithStatus
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: status
|
||||
- name: message
|
||||
default: 'null'
|
||||
- name: code
|
||||
default: 'null'
|
||||
comment: '# * Deny with a HTTP status code.
|
||||
|
||||
# *
|
||||
|
||||
# * @param int $status
|
||||
|
||||
# * @param string|null $message
|
||||
|
||||
# * @param int|null $code
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response'
|
||||
- name: denyAsNotFound
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: message
|
||||
default: 'null'
|
||||
- name: code
|
||||
default: 'null'
|
||||
comment: '# * Deny with a 404 HTTP status code.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $message
|
||||
|
||||
# * @param int|null $code
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response'
|
||||
traits: []
|
||||
interfaces: []
|
||||
|
|
@ -1,213 +0,0 @@
|
|||
name: Response
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Arrayable
|
||||
type: class
|
||||
source: Illuminate\Contracts\Support\Arrayable
|
||||
- name: Stringable
|
||||
type: class
|
||||
source: Stringable
|
||||
properties:
|
||||
- name: allowed
|
||||
visibility: protected
|
||||
comment: '# * Indicates whether the response was allowed.
|
||||
|
||||
# *
|
||||
|
||||
# * @var bool'
|
||||
- name: message
|
||||
visibility: protected
|
||||
comment: '# * The response message.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string|null'
|
||||
- name: code
|
||||
visibility: protected
|
||||
comment: '# * The response code.
|
||||
|
||||
# *
|
||||
|
||||
# * @var mixed'
|
||||
- name: status
|
||||
visibility: protected
|
||||
comment: '# * The HTTP response status code.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int|null'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: allowed
|
||||
- name: message
|
||||
default: ''''''
|
||||
- name: code
|
||||
default: 'null'
|
||||
comment: "# * Indicates whether the response was allowed.\n# *\n# * @var bool\n\
|
||||
# */\n# protected $allowed;\n# \n# /**\n# * The response message.\n# *\n# * @var\
|
||||
\ string|null\n# */\n# protected $message;\n# \n# /**\n# * The response code.\n\
|
||||
# *\n# * @var mixed\n# */\n# protected $code;\n# \n# /**\n# * The HTTP response\
|
||||
\ status code.\n# *\n# * @var int|null\n# */\n# protected $status;\n# \n# /**\n\
|
||||
# * Create a new response.\n# *\n# * @param bool $allowed\n# * @param string|null\
|
||||
\ $message\n# * @param mixed $code\n# * @return void"
|
||||
- name: allow
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: message
|
||||
default: 'null'
|
||||
- name: code
|
||||
default: 'null'
|
||||
comment: '# * Create a new "allow" Response.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $message
|
||||
|
||||
# * @param mixed $code
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response'
|
||||
- name: deny
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: message
|
||||
default: 'null'
|
||||
- name: code
|
||||
default: 'null'
|
||||
comment: '# * Create a new "deny" Response.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $message
|
||||
|
||||
# * @param mixed $code
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response'
|
||||
- name: denyWithStatus
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: status
|
||||
- name: message
|
||||
default: 'null'
|
||||
- name: code
|
||||
default: 'null'
|
||||
comment: '# * Create a new "deny" Response with a HTTP status code.
|
||||
|
||||
# *
|
||||
|
||||
# * @param int $status
|
||||
|
||||
# * @param string|null $message
|
||||
|
||||
# * @param mixed $code
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response'
|
||||
- name: denyAsNotFound
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: message
|
||||
default: 'null'
|
||||
- name: code
|
||||
default: 'null'
|
||||
comment: '# * Create a new "deny" Response with a 404 HTTP status code.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $message
|
||||
|
||||
# * @param mixed $code
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response'
|
||||
- name: allowed
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the response was allowed.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: denied
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the response was denied.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: message
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the response message.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string|null'
|
||||
- name: code
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the response code / reason.
|
||||
|
||||
# *
|
||||
|
||||
# * @return mixed'
|
||||
- name: authorize
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Throw authorization exception if response was denied.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Auth\Access\Response
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Auth\Access\AuthorizationException'
|
||||
- name: withStatus
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: status
|
||||
comment: '# * Set the HTTP response status code.
|
||||
|
||||
# *
|
||||
|
||||
# * @param null|int $status
|
||||
|
||||
# * @return $this'
|
||||
- name: asNotFound
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Set the HTTP response status code to 404.
|
||||
|
||||
# *
|
||||
|
||||
# * @return $this'
|
||||
- name: status
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the HTTP status code.
|
||||
|
||||
# *
|
||||
|
||||
# * @return int|null'
|
||||
- name: toArray
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Convert the response to an array.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
- name: __toString
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the string representation of the message.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
traits:
|
||||
- Illuminate\Contracts\Support\Arrayable
|
||||
- Stringable
|
||||
interfaces:
|
||||
- Arrayable
|
||||
|
|
@ -1,285 +0,0 @@
|
|||
name: AuthManager
|
||||
class_comment: '# * @mixin \Illuminate\Contracts\Auth\Guard
|
||||
|
||||
# * @mixin \Illuminate\Contracts\Auth\StatefulGuard'
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: FactoryContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Factory
|
||||
- name: InvalidArgumentException
|
||||
type: class
|
||||
source: InvalidArgumentException
|
||||
- name: CreatesUserProviders
|
||||
type: class
|
||||
source: CreatesUserProviders
|
||||
properties:
|
||||
- name: app
|
||||
visibility: protected
|
||||
comment: "# * @mixin \\Illuminate\\Contracts\\Auth\\Guard\n# * @mixin \\Illuminate\\\
|
||||
Contracts\\Auth\\StatefulGuard\n# */\n# class AuthManager implements FactoryContract\n\
|
||||
# {\n# use CreatesUserProviders;\n# \n# /**\n# * The application instance.\n#\
|
||||
\ *\n# * @var \\Illuminate\\Contracts\\Foundation\\Application"
|
||||
- name: customCreators
|
||||
visibility: protected
|
||||
comment: '# * The registered custom driver creators.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: guards
|
||||
visibility: protected
|
||||
comment: '# * The array of created "drivers".
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: userResolver
|
||||
visibility: protected
|
||||
comment: '# * The user resolver shared by various services.
|
||||
|
||||
# *
|
||||
|
||||
# * Determines the default user for Gate, Request, and the Authenticatable contract.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Closure'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: app
|
||||
comment: "# * @mixin \\Illuminate\\Contracts\\Auth\\Guard\n# * @mixin \\Illuminate\\\
|
||||
Contracts\\Auth\\StatefulGuard\n# */\n# class AuthManager implements FactoryContract\n\
|
||||
# {\n# use CreatesUserProviders;\n# \n# /**\n# * The application instance.\n#\
|
||||
\ *\n# * @var \\Illuminate\\Contracts\\Foundation\\Application\n# */\n# protected\
|
||||
\ $app;\n# \n# /**\n# * The registered custom driver creators.\n# *\n# * @var\
|
||||
\ array\n# */\n# protected $customCreators = [];\n# \n# /**\n# * The array of\
|
||||
\ created \"drivers\".\n# *\n# * @var array\n# */\n# protected $guards = [];\n\
|
||||
# \n# /**\n# * The user resolver shared by various services.\n# *\n# * Determines\
|
||||
\ the default user for Gate, Request, and the Authenticatable contract.\n# *\n\
|
||||
# * @var \\Closure\n# */\n# protected $userResolver;\n# \n# /**\n# * Create a\
|
||||
\ new Auth manager instance.\n# *\n# * @param \\Illuminate\\Contracts\\Foundation\\\
|
||||
Application $app\n# * @return void"
|
||||
- name: guard
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
default: 'null'
|
||||
comment: '# * Attempt to get the guard from the local cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $name
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Guard|\Illuminate\Contracts\Auth\StatefulGuard'
|
||||
- name: resolve
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Resolve the given guard.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Guard|\Illuminate\Contracts\Auth\StatefulGuard
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \InvalidArgumentException'
|
||||
- name: callCustomCreator
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: name
|
||||
- name: config
|
||||
comment: '# * Call a custom driver creator.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return mixed'
|
||||
- name: createSessionDriver
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
- name: config
|
||||
comment: '# * Create a session based authentication guard.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return \Illuminate\Auth\SessionGuard'
|
||||
- name: createTokenDriver
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
- name: config
|
||||
comment: '# * Create a token based authentication guard.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return \Illuminate\Auth\TokenGuard'
|
||||
- name: getConfig
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Get the guard configuration.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @return array'
|
||||
- name: getDefaultDriver
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the default authentication driver name.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: shouldUse
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Set the default guard driver the factory should serve.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @return void'
|
||||
- name: setDefaultDriver
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Set the default authentication driver name.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @return void'
|
||||
- name: viaRequest
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: driver
|
||||
- name: callback
|
||||
comment: '# * Register a new callback based request guard.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $driver
|
||||
|
||||
# * @param callable $callback
|
||||
|
||||
# * @return $this'
|
||||
- name: userResolver
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the user resolver callback.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Closure'
|
||||
- name: resolveUsersUsing
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: userResolver
|
||||
comment: '# * Set the callback to be used to resolve users.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Closure $userResolver
|
||||
|
||||
# * @return $this'
|
||||
- name: extend
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: driver
|
||||
- name: callback
|
||||
comment: '# * Register a custom driver creator Closure.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $driver
|
||||
|
||||
# * @param \Closure $callback
|
||||
|
||||
# * @return $this'
|
||||
- name: provider
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
- name: callback
|
||||
comment: '# * Register a custom provider creator Closure.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @param \Closure $callback
|
||||
|
||||
# * @return $this'
|
||||
- name: hasResolvedGuards
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determines if any guards have already been resolved.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: forgetGuards
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Forget all of the resolved guard instances.
|
||||
|
||||
# *
|
||||
|
||||
# * @return $this'
|
||||
- name: setApplication
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: app
|
||||
comment: '# * Set the application instance used by the manager.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Foundation\Application $app
|
||||
|
||||
# * @return $this'
|
||||
- name: __call
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: method
|
||||
- name: parameters
|
||||
comment: '# * Dynamically call the default driver instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $method
|
||||
|
||||
# * @param array $parameters
|
||||
|
||||
# * @return mixed'
|
||||
traits:
|
||||
- Closure
|
||||
- InvalidArgumentException
|
||||
- CreatesUserProviders
|
||||
interfaces:
|
||||
- FactoryContract
|
||||
- a
|
||||
|
|
@ -1,89 +0,0 @@
|
|||
name: AuthServiceProvider
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Gate
|
||||
type: class
|
||||
source: Illuminate\Auth\Access\Gate
|
||||
- name: RequirePassword
|
||||
type: class
|
||||
source: Illuminate\Auth\Middleware\RequirePassword
|
||||
- name: GateContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Access\Gate
|
||||
- name: AuthenticatableContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Authenticatable
|
||||
- name: ResponseFactory
|
||||
type: class
|
||||
source: Illuminate\Contracts\Routing\ResponseFactory
|
||||
- name: UrlGenerator
|
||||
type: class
|
||||
source: Illuminate\Contracts\Routing\UrlGenerator
|
||||
- name: ServiceProvider
|
||||
type: class
|
||||
source: Illuminate\Support\ServiceProvider
|
||||
properties: []
|
||||
methods:
|
||||
- name: register
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Register the service provider.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: registerAuthenticator
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Register the authenticator services.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: registerUserResolver
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Register a resolver for the authenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: registerAccessGate
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Register the access gate service.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: registerRequirePassword
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Register a resolver for the authenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: registerRequestRebindHandler
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Handle the re-binding of the request binding.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: registerEventRebindHandler
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Handle the re-binding of the event dispatcher binding.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Illuminate\Auth\Access\Gate
|
||||
- Illuminate\Auth\Middleware\RequirePassword
|
||||
- Illuminate\Contracts\Routing\ResponseFactory
|
||||
- Illuminate\Contracts\Routing\UrlGenerator
|
||||
- Illuminate\Support\ServiceProvider
|
||||
interfaces: []
|
||||
|
|
@ -1,88 +0,0 @@
|
|||
name: Authenticatable
|
||||
class_comment: null
|
||||
dependencies: []
|
||||
properties:
|
||||
- name: authPasswordName
|
||||
visibility: protected
|
||||
comment: '# * The column name of the password field using during authentication.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: rememberTokenName
|
||||
visibility: protected
|
||||
comment: '# * The column name of the "remember me" token.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
methods:
|
||||
- name: getAuthIdentifierName
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: "# * The column name of the password field using during authentication.\n\
|
||||
# *\n# * @var string\n# */\n# protected $authPasswordName = 'password';\n# \n\
|
||||
# /**\n# * The column name of the \"remember me\" token.\n# *\n# * @var string\n\
|
||||
# */\n# protected $rememberTokenName = 'remember_token';\n# \n# /**\n# * Get the\
|
||||
\ name of the unique identifier for the user.\n# *\n# * @return string"
|
||||
- name: getAuthIdentifier
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the unique identifier for the user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return mixed'
|
||||
- name: getAuthIdentifierForBroadcasting
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the unique broadcast identifier for the user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return mixed'
|
||||
- name: getAuthPasswordName
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the name of the password attribute for the user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: getAuthPassword
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the password for the user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: getRememberToken
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the token value for the "remember me" session.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string|null'
|
||||
- name: setRememberToken
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: value
|
||||
comment: '# * Set the token value for the "remember me" session.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $value
|
||||
|
||||
# * @return void'
|
||||
- name: getRememberTokenName
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the column name for the "remember me" token.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
traits: []
|
||||
interfaces: []
|
||||
|
|
@ -1,85 +0,0 @@
|
|||
name: AuthenticationException
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Exception
|
||||
type: class
|
||||
source: Exception
|
||||
- name: Request
|
||||
type: class
|
||||
source: Illuminate\Http\Request
|
||||
properties:
|
||||
- name: guards
|
||||
visibility: protected
|
||||
comment: '# * All of the guards that were checked.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: redirectTo
|
||||
visibility: protected
|
||||
comment: '# * The path the user should be redirected to.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string|null'
|
||||
- name: redirectToCallback
|
||||
visibility: protected
|
||||
comment: '# * The callback that should be used to generate the authentication redirect
|
||||
path.
|
||||
|
||||
# *
|
||||
|
||||
# * @var callable'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: message
|
||||
default: '''Unauthenticated.'''
|
||||
- name: guards
|
||||
default: '[]'
|
||||
- name: redirectTo
|
||||
default: 'null'
|
||||
comment: "# * All of the guards that were checked.\n# *\n# * @var array\n# */\n\
|
||||
# protected $guards;\n# \n# /**\n# * The path the user should be redirected to.\n\
|
||||
# *\n# * @var string|null\n# */\n# protected $redirectTo;\n# \n# /**\n# * The\
|
||||
\ callback that should be used to generate the authentication redirect path.\n\
|
||||
# *\n# * @var callable\n# */\n# protected static $redirectToCallback;\n# \n# /**\n\
|
||||
# * Create a new authentication exception.\n# *\n# * @param string $message\n\
|
||||
# * @param array $guards\n# * @param string|null $redirectTo\n# * @return\
|
||||
\ void"
|
||||
- name: guards
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the guards that were checked.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
- name: redirectTo
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
comment: '# * Get the path the user should be redirected to.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @return string|null'
|
||||
- name: redirectUsing
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: redirectToCallback
|
||||
comment: '# * Specify the callback that should be used to generate the redirect
|
||||
path.
|
||||
|
||||
# *
|
||||
|
||||
# * @param callable $redirectToCallback
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Exception
|
||||
- Illuminate\Http\Request
|
||||
interfaces: []
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
name: ClearResetsCommand
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Command
|
||||
type: class
|
||||
source: Illuminate\Console\Command
|
||||
- name: AsCommand
|
||||
type: class
|
||||
source: Symfony\Component\Console\Attribute\AsCommand
|
||||
properties:
|
||||
- name: signature
|
||||
visibility: protected
|
||||
comment: '# * The name and signature of the console command.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: description
|
||||
visibility: protected
|
||||
comment: '# * The console command description.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
methods:
|
||||
- name: handle
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: "# * The name and signature of the console command.\n# *\n# * @var string\n\
|
||||
# */\n# protected $signature = 'auth:clear-resets {name? : The name of the password\
|
||||
\ broker}';\n# \n# /**\n# * The console command description.\n# *\n# * @var string\n\
|
||||
# */\n# protected $description = 'Flush expired password reset tokens';\n# \n\
|
||||
# /**\n# * Execute the console command.\n# *\n# * @return void"
|
||||
traits:
|
||||
- Illuminate\Console\Command
|
||||
- Symfony\Component\Console\Attribute\AsCommand
|
||||
interfaces: []
|
||||
|
|
@ -1,69 +0,0 @@
|
|||
name: CreatesUserProviders
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: InvalidArgumentException
|
||||
type: class
|
||||
source: InvalidArgumentException
|
||||
properties:
|
||||
- name: customProviderCreators
|
||||
visibility: protected
|
||||
comment: '# * The registered custom provider creators.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
methods:
|
||||
- name: createUserProvider
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: provider
|
||||
default: 'null'
|
||||
comment: "# * The registered custom provider creators.\n# *\n# * @var array\n# */\n\
|
||||
# protected $customProviderCreators = [];\n# \n# /**\n# * Create the user provider\
|
||||
\ implementation for the driver.\n# *\n# * @param string|null $provider\n# *\
|
||||
\ @return \\Illuminate\\Contracts\\Auth\\UserProvider|null\n# *\n# * @throws \\\
|
||||
InvalidArgumentException"
|
||||
- name: getProviderConfiguration
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: provider
|
||||
comment: '# * Get the user provider configuration.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $provider
|
||||
|
||||
# * @return array|null'
|
||||
- name: createDatabaseProvider
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: config
|
||||
comment: '# * Create an instance of the database user provider.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return \Illuminate\Auth\DatabaseUserProvider'
|
||||
- name: createEloquentProvider
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: config
|
||||
comment: '# * Create an instance of the Eloquent user provider.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return \Illuminate\Auth\EloquentUserProvider'
|
||||
- name: getDefaultUserProvider
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the default user provider name.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
traits:
|
||||
- InvalidArgumentException
|
||||
interfaces: []
|
||||
|
|
@ -1,158 +0,0 @@
|
|||
name: DatabaseUserProvider
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: UserContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Authenticatable
|
||||
- name: UserProvider
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\UserProvider
|
||||
- name: HasherContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Hashing\Hasher
|
||||
- name: Arrayable
|
||||
type: class
|
||||
source: Illuminate\Contracts\Support\Arrayable
|
||||
- name: ConnectionInterface
|
||||
type: class
|
||||
source: Illuminate\Database\ConnectionInterface
|
||||
properties:
|
||||
- name: connection
|
||||
visibility: protected
|
||||
comment: '# * The active database connection.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Database\ConnectionInterface'
|
||||
- name: hasher
|
||||
visibility: protected
|
||||
comment: '# * The hasher implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Hashing\Hasher'
|
||||
- name: table
|
||||
visibility: protected
|
||||
comment: '# * The table containing the users.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: connection
|
||||
- name: hasher
|
||||
- name: table
|
||||
comment: "# * The active database connection.\n# *\n# * @var \\Illuminate\\Database\\\
|
||||
ConnectionInterface\n# */\n# protected $connection;\n# \n# /**\n# * The hasher\
|
||||
\ implementation.\n# *\n# * @var \\Illuminate\\Contracts\\Hashing\\Hasher\n# */\n\
|
||||
# protected $hasher;\n# \n# /**\n# * The table containing the users.\n# *\n# *\
|
||||
\ @var string\n# */\n# protected $table;\n# \n# /**\n# * Create a new database\
|
||||
\ user provider.\n# *\n# * @param \\Illuminate\\Database\\ConnectionInterface\
|
||||
\ $connection\n# * @param \\Illuminate\\Contracts\\Hashing\\Hasher $hasher\n\
|
||||
# * @param string $table\n# * @return void"
|
||||
- name: retrieveById
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: identifier
|
||||
comment: '# * Retrieve a user by their unique identifier.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $identifier
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
|
||||
- name: retrieveByToken
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: identifier
|
||||
- name: token
|
||||
comment: '# * Retrieve a user by their unique identifier and "remember me" token.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $identifier
|
||||
|
||||
# * @param string $token
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
|
||||
- name: updateRememberToken
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
- name: token
|
||||
comment: '# * Update the "remember me" token for the given user in storage.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @param string $token
|
||||
|
||||
# * @return void'
|
||||
- name: retrieveByCredentials
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: credentials
|
||||
comment: '# * Retrieve a user by the given credentials.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
|
||||
- name: getGenericUser
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Get the generic user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $user
|
||||
|
||||
# * @return \Illuminate\Auth\GenericUser|null'
|
||||
- name: validateCredentials
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
- name: credentials
|
||||
comment: '# * Validate a user against the given credentials.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @return bool'
|
||||
- name: rehashPasswordIfRequired
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
- name: credentials
|
||||
- name: force
|
||||
default: 'false'
|
||||
comment: '# * Rehash the user''s password if required and supported.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @param bool $force
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Closure
|
||||
- Illuminate\Contracts\Auth\UserProvider
|
||||
- Illuminate\Contracts\Support\Arrayable
|
||||
- Illuminate\Database\ConnectionInterface
|
||||
interfaces:
|
||||
- UserProvider
|
||||
|
|
@ -1,223 +0,0 @@
|
|||
name: EloquentUserProvider
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: UserContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Authenticatable
|
||||
- name: UserProvider
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\UserProvider
|
||||
- name: HasherContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Hashing\Hasher
|
||||
- name: Arrayable
|
||||
type: class
|
||||
source: Illuminate\Contracts\Support\Arrayable
|
||||
properties:
|
||||
- name: hasher
|
||||
visibility: protected
|
||||
comment: '# * The hasher implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Hashing\Hasher'
|
||||
- name: model
|
||||
visibility: protected
|
||||
comment: '# * The Eloquent user model.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: queryCallback
|
||||
visibility: protected
|
||||
comment: '# * The callback that may modify the user retrieval queries.
|
||||
|
||||
# *
|
||||
|
||||
# * @var (\Closure(\Illuminate\Database\Eloquent\Builder<*>):mixed)|null'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: hasher
|
||||
- name: model
|
||||
comment: "# * The hasher implementation.\n# *\n# * @var \\Illuminate\\Contracts\\\
|
||||
Hashing\\Hasher\n# */\n# protected $hasher;\n# \n# /**\n# * The Eloquent user\
|
||||
\ model.\n# *\n# * @var string\n# */\n# protected $model;\n# \n# /**\n# * The\
|
||||
\ callback that may modify the user retrieval queries.\n# *\n# * @var (\\Closure(\\\
|
||||
Illuminate\\Database\\Eloquent\\Builder<*>):mixed)|null\n# */\n# protected $queryCallback;\n\
|
||||
# \n# /**\n# * Create a new database user provider.\n# *\n# * @param \\Illuminate\\\
|
||||
Contracts\\Hashing\\Hasher $hasher\n# * @param string $model\n# * @return void"
|
||||
- name: retrieveById
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: identifier
|
||||
comment: '# * Retrieve a user by their unique identifier.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $identifier
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
|
||||
- name: retrieveByToken
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: identifier
|
||||
- name: token
|
||||
comment: '# * Retrieve a user by their unique identifier and "remember me" token.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $identifier
|
||||
|
||||
# * @param string $token
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
|
||||
- name: updateRememberToken
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
- name: token
|
||||
comment: '# * Update the "remember me" token for the given user in storage.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @param string $token
|
||||
|
||||
# * @return void'
|
||||
- name: retrieveByCredentials
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: credentials
|
||||
comment: '# * Retrieve a user by the given credentials.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
|
||||
- name: validateCredentials
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
- name: credentials
|
||||
comment: '# * Validate a user against the given credentials.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @return bool'
|
||||
- name: rehashPasswordIfRequired
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
- name: credentials
|
||||
- name: force
|
||||
default: 'false'
|
||||
comment: '# * Rehash the user''s password if required and supported.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @param bool $force
|
||||
|
||||
# * @return void'
|
||||
- name: newModelQuery
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: model
|
||||
default: 'null'
|
||||
comment: '# * Get a new query builder for the model instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @template TModel of \Illuminate\Database\Eloquent\Model
|
||||
|
||||
# *
|
||||
|
||||
# * @param TModel|null $model
|
||||
|
||||
# * @return \Illuminate\Database\Eloquent\Builder<TModel>'
|
||||
- name: createModel
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Create a new instance of the model.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Database\Eloquent\Model'
|
||||
- name: getHasher
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Gets the hasher implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Contracts\Hashing\Hasher'
|
||||
- name: setHasher
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: hasher
|
||||
comment: '# * Sets the hasher implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Hashing\Hasher $hasher
|
||||
|
||||
# * @return $this'
|
||||
- name: getModel
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Gets the name of the Eloquent user model.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: setModel
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: model
|
||||
comment: '# * Sets the name of the Eloquent user model.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $model
|
||||
|
||||
# * @return $this'
|
||||
- name: getQueryCallback
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the callback that modifies the query before retrieving users.
|
||||
|
||||
# *
|
||||
|
||||
# * @return (\Closure(\Illuminate\Database\Eloquent\Builder<*>):mixed)|null'
|
||||
- name: withQuery
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: queryCallback
|
||||
default: 'null'
|
||||
comment: '# * Sets the callback to modify the query before retrieving users.
|
||||
|
||||
# *
|
||||
|
||||
# * @param (\Closure(\Illuminate\Database\Eloquent\Builder<*>):mixed)|null $queryCallback
|
||||
|
||||
# * @return $this'
|
||||
traits:
|
||||
- Closure
|
||||
- Illuminate\Contracts\Auth\UserProvider
|
||||
- Illuminate\Contracts\Support\Arrayable
|
||||
interfaces:
|
||||
- UserProvider
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
name: Attempting
|
||||
class_comment: null
|
||||
dependencies: []
|
||||
properties:
|
||||
- name: guard
|
||||
visibility: public
|
||||
comment: '# * The authentication guard name.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: credentials
|
||||
visibility: public
|
||||
comment: '# * The credentials for the user.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: remember
|
||||
visibility: public
|
||||
comment: '# * Indicates if the user should be "remembered".
|
||||
|
||||
# *
|
||||
|
||||
# * @var bool'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: guard
|
||||
- name: credentials
|
||||
- name: remember
|
||||
comment: "# * The authentication guard name.\n# *\n# * @var string\n# */\n# public\
|
||||
\ $guard;\n# \n# /**\n# * The credentials for the user.\n# *\n# * @var array\n\
|
||||
# */\n# public $credentials;\n# \n# /**\n# * Indicates if the user should be \"\
|
||||
remembered\".\n# *\n# * @var bool\n# */\n# public $remember;\n# \n# /**\n# * Create\
|
||||
\ a new event instance.\n# *\n# * @param string $guard\n# * @param array $credentials\n\
|
||||
# * @param bool $remember\n# * @return void"
|
||||
traits: []
|
||||
interfaces: []
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
name: Authenticated
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: Illuminate\Queue\SerializesModels
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: SerializesModels
|
||||
properties:
|
||||
- name: guard
|
||||
visibility: public
|
||||
comment: '# * The authentication guard name.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: user
|
||||
visibility: public
|
||||
comment: '# * The authenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\Authenticatable'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: guard
|
||||
- name: user
|
||||
comment: "# * The authentication guard name.\n# *\n# * @var string\n# */\n# public\
|
||||
\ $guard;\n# \n# /**\n# * The authenticated user.\n# *\n# * @var \\Illuminate\\\
|
||||
Contracts\\Auth\\Authenticatable\n# */\n# public $user;\n# \n# /**\n# * Create\
|
||||
\ a new event instance.\n# *\n# * @param string $guard\n# * @param \\Illuminate\\\
|
||||
Contracts\\Auth\\Authenticatable $user\n# * @return void"
|
||||
traits:
|
||||
- Illuminate\Queue\SerializesModels
|
||||
- SerializesModels
|
||||
interfaces: []
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
name: CurrentDeviceLogout
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: Illuminate\Queue\SerializesModels
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: SerializesModels
|
||||
properties:
|
||||
- name: guard
|
||||
visibility: public
|
||||
comment: '# * The authentication guard name.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: user
|
||||
visibility: public
|
||||
comment: '# * The authenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\Authenticatable'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: guard
|
||||
- name: user
|
||||
comment: "# * The authentication guard name.\n# *\n# * @var string\n# */\n# public\
|
||||
\ $guard;\n# \n# /**\n# * The authenticated user.\n# *\n# * @var \\Illuminate\\\
|
||||
Contracts\\Auth\\Authenticatable\n# */\n# public $user;\n# \n# /**\n# * Create\
|
||||
\ a new event instance.\n# *\n# * @param string $guard\n# * @param \\Illuminate\\\
|
||||
Contracts\\Auth\\Authenticatable $user\n# * @return void"
|
||||
traits:
|
||||
- Illuminate\Queue\SerializesModels
|
||||
- SerializesModels
|
||||
interfaces: []
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
name: Failed
|
||||
class_comment: null
|
||||
dependencies: []
|
||||
properties:
|
||||
- name: guard
|
||||
visibility: public
|
||||
comment: '# * The authentication guard name.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: user
|
||||
visibility: public
|
||||
comment: '# * The user the attempter was trying to authenticate as.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\Authenticatable|null'
|
||||
- name: credentials
|
||||
visibility: public
|
||||
comment: '# * The credentials provided by the attempter.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: guard
|
||||
- name: user
|
||||
- name: credentials
|
||||
comment: "# * The authentication guard name.\n# *\n# * @var string\n# */\n# public\
|
||||
\ $guard;\n# \n# /**\n# * The user the attempter was trying to authenticate as.\n\
|
||||
# *\n# * @var \\Illuminate\\Contracts\\Auth\\Authenticatable|null\n# */\n# public\
|
||||
\ $user;\n# \n# /**\n# * The credentials provided by the attempter.\n# *\n# *\
|
||||
\ @var array\n# */\n# public $credentials;\n# \n# /**\n# * Create a new event\
|
||||
\ instance.\n# *\n# * @param string $guard\n# * @param \\Illuminate\\Contracts\\\
|
||||
Auth\\Authenticatable|null $user\n# * @param array $credentials\n# * @return\
|
||||
\ void"
|
||||
traits: []
|
||||
interfaces: []
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
name: Lockout
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Request
|
||||
type: class
|
||||
source: Illuminate\Http\Request
|
||||
properties:
|
||||
- name: request
|
||||
visibility: public
|
||||
comment: '# * The throttled request.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Http\Request'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
comment: "# * The throttled request.\n# *\n# * @var \\Illuminate\\Http\\Request\n\
|
||||
# */\n# public $request;\n# \n# /**\n# * Create a new event instance.\n# *\n#\
|
||||
\ * @param \\Illuminate\\Http\\Request $request\n# * @return void"
|
||||
traits:
|
||||
- Illuminate\Http\Request
|
||||
interfaces: []
|
||||
|
|
@ -1,49 +0,0 @@
|
|||
name: Login
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: Illuminate\Queue\SerializesModels
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: SerializesModels
|
||||
properties:
|
||||
- name: guard
|
||||
visibility: public
|
||||
comment: '# * The authentication guard name.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: user
|
||||
visibility: public
|
||||
comment: '# * The authenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\Authenticatable'
|
||||
- name: remember
|
||||
visibility: public
|
||||
comment: '# * Indicates if the user should be "remembered".
|
||||
|
||||
# *
|
||||
|
||||
# * @var bool'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: guard
|
||||
- name: user
|
||||
- name: remember
|
||||
comment: "# * The authentication guard name.\n# *\n# * @var string\n# */\n# public\
|
||||
\ $guard;\n# \n# /**\n# * The authenticated user.\n# *\n# * @var \\Illuminate\\\
|
||||
Contracts\\Auth\\Authenticatable\n# */\n# public $user;\n# \n# /**\n# * Indicates\
|
||||
\ if the user should be \"remembered\".\n# *\n# * @var bool\n# */\n# public $remember;\n\
|
||||
# \n# /**\n# * Create a new event instance.\n# *\n# * @param string $guard\n\
|
||||
# * @param \\Illuminate\\Contracts\\Auth\\Authenticatable $user\n# * @param\
|
||||
\ bool $remember\n# * @return void"
|
||||
traits:
|
||||
- Illuminate\Queue\SerializesModels
|
||||
- SerializesModels
|
||||
interfaces: []
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
name: Logout
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: Illuminate\Queue\SerializesModels
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: SerializesModels
|
||||
properties:
|
||||
- name: guard
|
||||
visibility: public
|
||||
comment: '# * The authentication guard name.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: user
|
||||
visibility: public
|
||||
comment: '# * The authenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\Authenticatable'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: guard
|
||||
- name: user
|
||||
comment: "# * The authentication guard name.\n# *\n# * @var string\n# */\n# public\
|
||||
\ $guard;\n# \n# /**\n# * The authenticated user.\n# *\n# * @var \\Illuminate\\\
|
||||
Contracts\\Auth\\Authenticatable\n# */\n# public $user;\n# \n# /**\n# * Create\
|
||||
\ a new event instance.\n# *\n# * @param string $guard\n# * @param \\Illuminate\\\
|
||||
Contracts\\Auth\\Authenticatable $user\n# * @return void"
|
||||
traits:
|
||||
- Illuminate\Queue\SerializesModels
|
||||
- SerializesModels
|
||||
interfaces: []
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
name: OtherDeviceLogout
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: Illuminate\Queue\SerializesModels
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: SerializesModels
|
||||
properties:
|
||||
- name: guard
|
||||
visibility: public
|
||||
comment: '# * The authentication guard name.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: user
|
||||
visibility: public
|
||||
comment: '# * The authenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\Authenticatable'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: guard
|
||||
- name: user
|
||||
comment: "# * The authentication guard name.\n# *\n# * @var string\n# */\n# public\
|
||||
\ $guard;\n# \n# /**\n# * The authenticated user.\n# *\n# * @var \\Illuminate\\\
|
||||
Contracts\\Auth\\Authenticatable\n# */\n# public $user;\n# \n# /**\n# * Create\
|
||||
\ a new event instance.\n# *\n# * @param string $guard\n# * @param \\Illuminate\\\
|
||||
Contracts\\Auth\\Authenticatable $user\n# * @return void"
|
||||
traits:
|
||||
- Illuminate\Queue\SerializesModels
|
||||
- SerializesModels
|
||||
interfaces: []
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
name: PasswordReset
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: Illuminate\Queue\SerializesModels
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: SerializesModels
|
||||
properties:
|
||||
- name: user
|
||||
visibility: public
|
||||
comment: '# * The user.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\Authenticatable'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: "# * The user.\n# *\n# * @var \\Illuminate\\Contracts\\Auth\\Authenticatable\n\
|
||||
# */\n# public $user;\n# \n# /**\n# * Create a new event instance.\n# *\n# * @param\
|
||||
\ \\Illuminate\\Contracts\\Auth\\Authenticatable $user\n# * @return void"
|
||||
traits:
|
||||
- Illuminate\Queue\SerializesModels
|
||||
- SerializesModels
|
||||
interfaces: []
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
name: PasswordResetLinkSent
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: Illuminate\Queue\SerializesModels
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: SerializesModels
|
||||
properties:
|
||||
- name: user
|
||||
visibility: public
|
||||
comment: '# * The user instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\CanResetPassword'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: "# * The user instance.\n# *\n# * @var \\Illuminate\\Contracts\\Auth\\\
|
||||
CanResetPassword\n# */\n# public $user;\n# \n# /**\n# * Create a new event instance.\n\
|
||||
# *\n# * @param \\Illuminate\\Contracts\\Auth\\CanResetPassword $user\n# * @return\
|
||||
\ void"
|
||||
traits:
|
||||
- Illuminate\Queue\SerializesModels
|
||||
- SerializesModels
|
||||
interfaces: []
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
name: Registered
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: Illuminate\Queue\SerializesModels
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: SerializesModels
|
||||
properties:
|
||||
- name: user
|
||||
visibility: public
|
||||
comment: '# * The authenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\Authenticatable'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: "# * The authenticated user.\n# *\n# * @var \\Illuminate\\Contracts\\Auth\\\
|
||||
Authenticatable\n# */\n# public $user;\n# \n# /**\n# * Create a new event instance.\n\
|
||||
# *\n# * @param \\Illuminate\\Contracts\\Auth\\Authenticatable $user\n# * @return\
|
||||
\ void"
|
||||
traits:
|
||||
- Illuminate\Queue\SerializesModels
|
||||
- SerializesModels
|
||||
interfaces: []
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
name: Validated
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: Illuminate\Queue\SerializesModels
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: SerializesModels
|
||||
properties:
|
||||
- name: guard
|
||||
visibility: public
|
||||
comment: '# * The authentication guard name.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: user
|
||||
visibility: public
|
||||
comment: '# * The user retrieved and validated from the User Provider.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\Authenticatable'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: guard
|
||||
- name: user
|
||||
comment: "# * The authentication guard name.\n# *\n# * @var string\n# */\n# public\
|
||||
\ $guard;\n# \n# /**\n# * The user retrieved and validated from the User Provider.\n\
|
||||
# *\n# * @var \\Illuminate\\Contracts\\Auth\\Authenticatable\n# */\n# public $user;\n\
|
||||
# \n# /**\n# * Create a new event instance.\n# *\n# * @param string $guard\n\
|
||||
# * @param \\Illuminate\\Contracts\\Auth\\Authenticatable $user\n# * @return\
|
||||
\ void"
|
||||
traits:
|
||||
- Illuminate\Queue\SerializesModels
|
||||
- SerializesModels
|
||||
interfaces: []
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
name: Verified
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: Illuminate\Queue\SerializesModels
|
||||
- name: SerializesModels
|
||||
type: class
|
||||
source: SerializesModels
|
||||
properties:
|
||||
- name: user
|
||||
visibility: public
|
||||
comment: '# * The verified user.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\MustVerifyEmail'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: "# * The verified user.\n# *\n# * @var \\Illuminate\\Contracts\\Auth\\\
|
||||
MustVerifyEmail\n# */\n# public $user;\n# \n# /**\n# * Create a new event instance.\n\
|
||||
# *\n# * @param \\Illuminate\\Contracts\\Auth\\MustVerifyEmail $user\n# * @return\
|
||||
\ void"
|
||||
traits:
|
||||
- Illuminate\Queue\SerializesModels
|
||||
- SerializesModels
|
||||
interfaces: []
|
||||
|
|
@ -1,131 +0,0 @@
|
|||
name: GenericUser
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: UserContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Authenticatable
|
||||
properties:
|
||||
- name: attributes
|
||||
visibility: protected
|
||||
comment: '# * All of the user''s attributes.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: attributes
|
||||
comment: "# * All of the user's attributes.\n# *\n# * @var array\n# */\n# protected\
|
||||
\ $attributes;\n# \n# /**\n# * Create a new generic User object.\n# *\n# * @param\
|
||||
\ array $attributes\n# * @return void"
|
||||
- name: getAuthIdentifierName
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the name of the unique identifier for the user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: getAuthIdentifier
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the unique identifier for the user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return mixed'
|
||||
- name: getAuthPasswordName
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the name of the password attribute for the user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: getAuthPassword
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the password for the user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: getRememberToken
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the "remember me" token value.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: setRememberToken
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: value
|
||||
comment: '# * Set the "remember me" token value.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $value
|
||||
|
||||
# * @return void'
|
||||
- name: getRememberTokenName
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the column name for the "remember me" token.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: __get
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
comment: '# * Dynamically access the user''s attributes.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @return mixed'
|
||||
- name: __set
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
comment: '# * Dynamically set an attribute on the user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @return void'
|
||||
- name: __isset
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
comment: '# * Dynamically check if a value is set on the user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @return bool'
|
||||
- name: __unset
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
comment: '# * Dynamically unset a value on the user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @return void'
|
||||
traits: []
|
||||
interfaces:
|
||||
- UserContract
|
||||
|
|
@ -1,119 +0,0 @@
|
|||
name: GuardHelpers
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: AuthenticatableContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Authenticatable
|
||||
- name: UserProvider
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\UserProvider
|
||||
properties:
|
||||
- name: user
|
||||
visibility: protected
|
||||
comment: '# * These methods are typically the same across all guards.
|
||||
|
||||
# */
|
||||
|
||||
# trait GuardHelpers
|
||||
|
||||
# {
|
||||
|
||||
# /**
|
||||
|
||||
# * The currently authenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\Authenticatable|null'
|
||||
- name: provider
|
||||
visibility: protected
|
||||
comment: '# * The user provider implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\UserProvider'
|
||||
methods:
|
||||
- name: authenticate
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: "# * These methods are typically the same across all guards.\n# */\n# trait\
|
||||
\ GuardHelpers\n# {\n# /**\n# * The currently authenticated user.\n# *\n# * @var\
|
||||
\ \\Illuminate\\Contracts\\Auth\\Authenticatable|null\n# */\n# protected $user;\n\
|
||||
# \n# /**\n# * The user provider implementation.\n# *\n# * @var \\Illuminate\\\
|
||||
Contracts\\Auth\\UserProvider\n# */\n# protected $provider;\n# \n# /**\n# * Determine\
|
||||
\ if the current user is authenticated. If not, throw an exception.\n# *\n# *\
|
||||
\ @return \\Illuminate\\Contracts\\Auth\\Authenticatable\n# *\n# * @throws \\\
|
||||
Illuminate\\Auth\\AuthenticationException"
|
||||
- name: hasUser
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the guard has a user instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: check
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the current user is authenticated.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: guest
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the current user is a guest.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: id
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the ID for the currently authenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return int|string|null'
|
||||
- name: setUser
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Set the current user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @return $this'
|
||||
- name: forgetUser
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Forget the current user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return $this'
|
||||
- name: getProvider
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the user provider used by the guard.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\UserProvider'
|
||||
- name: setProvider
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: provider
|
||||
comment: '# * Set the user provider used by the guard.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\UserProvider $provider
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Illuminate\Contracts\Auth\UserProvider
|
||||
interfaces: []
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
name: SendEmailVerificationNotification
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Registered
|
||||
type: class
|
||||
source: Illuminate\Auth\Events\Registered
|
||||
- name: MustVerifyEmail
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\MustVerifyEmail
|
||||
properties: []
|
||||
methods:
|
||||
- name: handle
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: event
|
||||
comment: '# * Handle the event.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Auth\Events\Registered $event
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Illuminate\Auth\Events\Registered
|
||||
- Illuminate\Contracts\Auth\MustVerifyEmail
|
||||
interfaces: []
|
||||
|
|
@ -1,146 +0,0 @@
|
|||
name: Authenticate
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: AuthenticationException
|
||||
type: class
|
||||
source: Illuminate\Auth\AuthenticationException
|
||||
- name: Auth
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Factory
|
||||
- name: AuthenticatesRequests
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Middleware\AuthenticatesRequests
|
||||
- name: Request
|
||||
type: class
|
||||
source: Illuminate\Http\Request
|
||||
properties:
|
||||
- name: auth
|
||||
visibility: protected
|
||||
comment: '# * The authentication factory instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\Factory'
|
||||
- name: redirectToCallback
|
||||
visibility: protected
|
||||
comment: '# * The callback that should be used to generate the authentication redirect
|
||||
path.
|
||||
|
||||
# *
|
||||
|
||||
# * @var callable'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: auth
|
||||
comment: "# * The authentication factory instance.\n# *\n# * @var \\Illuminate\\\
|
||||
Contracts\\Auth\\Factory\n# */\n# protected $auth;\n# \n# /**\n# * The callback\
|
||||
\ that should be used to generate the authentication redirect path.\n# *\n# *\
|
||||
\ @var callable\n# */\n# protected static $redirectToCallback;\n# \n# /**\n# *\
|
||||
\ Create a new middleware instance.\n# *\n# * @param \\Illuminate\\Contracts\\\
|
||||
Auth\\Factory $auth\n# * @return void"
|
||||
- name: using
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: guard
|
||||
- name: '...$others'
|
||||
comment: '# * Specify the guards for the middleware.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $guard
|
||||
|
||||
# * @param string $others
|
||||
|
||||
# * @return string'
|
||||
- name: handle
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
- name: next
|
||||
- name: '...$guards'
|
||||
comment: '# * Handle an incoming request.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param \Closure $next
|
||||
|
||||
# * @param string[] ...$guards
|
||||
|
||||
# * @return mixed
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Auth\AuthenticationException'
|
||||
- name: authenticate
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: request
|
||||
- name: guards
|
||||
comment: '# * Determine if the user is logged in to any of the given guards.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param array $guards
|
||||
|
||||
# * @return void
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Auth\AuthenticationException'
|
||||
- name: unauthenticated
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: request
|
||||
- name: guards
|
||||
comment: '# * Handle an unauthenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param array $guards
|
||||
|
||||
# * @return void
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Auth\AuthenticationException'
|
||||
- name: redirectTo
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: request
|
||||
comment: '# * Get the path the user should be redirected to when they are not authenticated.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @return string|null'
|
||||
- name: redirectUsing
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: redirectToCallback
|
||||
comment: '# * Specify the callback that should be used to generate the redirect
|
||||
path.
|
||||
|
||||
# *
|
||||
|
||||
# * @param callable $redirectToCallback
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Closure
|
||||
- Illuminate\Auth\AuthenticationException
|
||||
- Illuminate\Contracts\Auth\Middleware\AuthenticatesRequests
|
||||
- Illuminate\Http\Request
|
||||
interfaces:
|
||||
- AuthenticatesRequests
|
||||
|
|
@ -1,75 +0,0 @@
|
|||
name: AuthenticateWithBasicAuth
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: AuthFactory
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Factory
|
||||
properties:
|
||||
- name: auth
|
||||
visibility: protected
|
||||
comment: '# * The guard factory instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\Factory'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: auth
|
||||
comment: "# * The guard factory instance.\n# *\n# * @var \\Illuminate\\Contracts\\\
|
||||
Auth\\Factory\n# */\n# protected $auth;\n# \n# /**\n# * Create a new middleware\
|
||||
\ instance.\n# *\n# * @param \\Illuminate\\Contracts\\Auth\\Factory $auth\n\
|
||||
# * @return void"
|
||||
- name: using
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: guard
|
||||
default: 'null'
|
||||
- name: field
|
||||
default: 'null'
|
||||
comment: '# * Specify the guard and field for the middleware.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $guard
|
||||
|
||||
# * @param string|null $field
|
||||
|
||||
# * @return string
|
||||
|
||||
# *
|
||||
|
||||
# * @named-arguments-supported'
|
||||
- name: handle
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
- name: next
|
||||
- name: guard
|
||||
default: 'null'
|
||||
- name: field
|
||||
default: 'null'
|
||||
comment: '# * Handle an incoming request.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param \Closure $next
|
||||
|
||||
# * @param string|null $guard
|
||||
|
||||
# * @param string|null $field
|
||||
|
||||
# * @return mixed
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException'
|
||||
traits:
|
||||
- Closure
|
||||
interfaces: []
|
||||
|
|
@ -1,113 +0,0 @@
|
|||
name: Authorize
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: Gate
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Access\Gate
|
||||
- name: Model
|
||||
type: class
|
||||
source: Illuminate\Database\Eloquent\Model
|
||||
properties:
|
||||
- name: gate
|
||||
visibility: protected
|
||||
comment: '# * The gate instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\Access\Gate'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: gate
|
||||
comment: "# * The gate instance.\n# *\n# * @var \\Illuminate\\Contracts\\Auth\\\
|
||||
Access\\Gate\n# */\n# protected $gate;\n# \n# /**\n# * Create a new middleware\
|
||||
\ instance.\n# *\n# * @param \\Illuminate\\Contracts\\Auth\\Access\\Gate $gate\n\
|
||||
# * @return void"
|
||||
- name: using
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: ability
|
||||
- name: '...$models'
|
||||
comment: '# * Specify the ability and models for the middleware.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @param string ...$models
|
||||
|
||||
# * @return string'
|
||||
- name: handle
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
- name: next
|
||||
- name: ability
|
||||
- name: '...$models'
|
||||
comment: '# * Handle an incoming request.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param \Closure $next
|
||||
|
||||
# * @param string $ability
|
||||
|
||||
# * @param array|null ...$models
|
||||
|
||||
# * @return mixed
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Auth\AuthenticationException
|
||||
|
||||
# * @throws \Illuminate\Auth\Access\AuthorizationException'
|
||||
- name: getGateArguments
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: request
|
||||
- name: models
|
||||
comment: '# * Get the arguments parameter for the gate.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param array|null $models
|
||||
|
||||
# * @return array'
|
||||
- name: getModel
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: request
|
||||
- name: model
|
||||
comment: '# * Get the model to authorize.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param string $model
|
||||
|
||||
# * @return \Illuminate\Database\Eloquent\Model|string'
|
||||
- name: isClassName
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: value
|
||||
comment: '# * Checks if the given string looks like a fully qualified class name.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $value
|
||||
|
||||
# * @return bool'
|
||||
traits:
|
||||
- Closure
|
||||
- Illuminate\Contracts\Auth\Access\Gate
|
||||
- Illuminate\Database\Eloquent\Model
|
||||
interfaces: []
|
||||
|
|
@ -1,52 +0,0 @@
|
|||
name: EnsureEmailIsVerified
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: MustVerifyEmail
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\MustVerifyEmail
|
||||
- name: Redirect
|
||||
type: class
|
||||
source: Illuminate\Support\Facades\Redirect
|
||||
- name: URL
|
||||
type: class
|
||||
source: Illuminate\Support\Facades\URL
|
||||
properties: []
|
||||
methods:
|
||||
- name: redirectTo
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: route
|
||||
comment: '# * Specify the redirect route for the middleware.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $route
|
||||
|
||||
# * @return string'
|
||||
- name: handle
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
- name: next
|
||||
- name: redirectToRoute
|
||||
default: 'null'
|
||||
comment: '# * Handle an incoming request.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param \Closure $next
|
||||
|
||||
# * @param string|null $redirectToRoute
|
||||
|
||||
# * @return \Illuminate\Http\Response|\Illuminate\Http\RedirectResponse|null'
|
||||
traits:
|
||||
- Closure
|
||||
- Illuminate\Contracts\Auth\MustVerifyEmail
|
||||
- Illuminate\Support\Facades\Redirect
|
||||
- Illuminate\Support\Facades\URL
|
||||
interfaces: []
|
||||
|
|
@ -1,67 +0,0 @@
|
|||
name: RedirectIfAuthenticated
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: Request
|
||||
type: class
|
||||
source: Illuminate\Http\Request
|
||||
- name: Auth
|
||||
type: class
|
||||
source: Illuminate\Support\Facades\Auth
|
||||
- name: Route
|
||||
type: class
|
||||
source: Illuminate\Support\Facades\Route
|
||||
- name: Response
|
||||
type: class
|
||||
source: Symfony\Component\HttpFoundation\Response
|
||||
properties:
|
||||
- name: redirectToCallback
|
||||
visibility: protected
|
||||
comment: '# * The callback that should be used to generate the authentication redirect
|
||||
path.
|
||||
|
||||
# *
|
||||
|
||||
# * @var callable|null'
|
||||
methods:
|
||||
- name: handle
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
- name: next
|
||||
- name: '...$guards'
|
||||
comment: "# * The callback that should be used to generate the authentication redirect\
|
||||
\ path.\n# *\n# * @var callable|null\n# */\n# protected static $redirectToCallback;\n\
|
||||
# \n# /**\n# * Handle an incoming request.\n# *\n# * @param \\Closure(\\Illuminate\\\
|
||||
Http\\Request): (\\Symfony\\Component\\HttpFoundation\\Response) $next"
|
||||
- name: redirectTo
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: request
|
||||
comment: '# * Get the path the user should be redirected to when they are authenticated.'
|
||||
- name: defaultRedirectUri
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Get the default URI the user should be redirected to when they are
|
||||
authenticated.'
|
||||
- name: redirectUsing
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: redirectToCallback
|
||||
comment: '# * Specify the callback that should be used to generate the redirect
|
||||
path.
|
||||
|
||||
# *
|
||||
|
||||
# * @param callable $redirectToCallback
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Closure
|
||||
- Illuminate\Http\Request
|
||||
- Illuminate\Support\Facades\Auth
|
||||
- Illuminate\Support\Facades\Route
|
||||
- Symfony\Component\HttpFoundation\Response
|
||||
interfaces: []
|
||||
|
|
@ -1,113 +0,0 @@
|
|||
name: RequirePassword
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: ResponseFactory
|
||||
type: class
|
||||
source: Illuminate\Contracts\Routing\ResponseFactory
|
||||
- name: UrlGenerator
|
||||
type: class
|
||||
source: Illuminate\Contracts\Routing\UrlGenerator
|
||||
properties:
|
||||
- name: responseFactory
|
||||
visibility: protected
|
||||
comment: '# * The response factory instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Routing\ResponseFactory'
|
||||
- name: urlGenerator
|
||||
visibility: protected
|
||||
comment: '# * The URL generator instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Routing\UrlGenerator'
|
||||
- name: passwordTimeout
|
||||
visibility: protected
|
||||
comment: '# * The password timeout.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: responseFactory
|
||||
- name: urlGenerator
|
||||
- name: passwordTimeout
|
||||
default: 'null'
|
||||
comment: "# * The response factory instance.\n# *\n# * @var \\Illuminate\\Contracts\\\
|
||||
Routing\\ResponseFactory\n# */\n# protected $responseFactory;\n# \n# /**\n# *\
|
||||
\ The URL generator instance.\n# *\n# * @var \\Illuminate\\Contracts\\Routing\\\
|
||||
UrlGenerator\n# */\n# protected $urlGenerator;\n# \n# /**\n# * The password timeout.\n\
|
||||
# *\n# * @var int\n# */\n# protected $passwordTimeout;\n# \n# /**\n# * Create\
|
||||
\ a new middleware instance.\n# *\n# * @param \\Illuminate\\Contracts\\Routing\\\
|
||||
ResponseFactory $responseFactory\n# * @param \\Illuminate\\Contracts\\Routing\\\
|
||||
UrlGenerator $urlGenerator\n# * @param int|null $passwordTimeout\n# * @return\
|
||||
\ void"
|
||||
- name: using
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: redirectToRoute
|
||||
default: 'null'
|
||||
- name: passwordTimeoutSeconds
|
||||
default: 'null'
|
||||
comment: '# * Specify the redirect route and timeout for the middleware.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $redirectToRoute
|
||||
|
||||
# * @param string|int|null $passwordTimeoutSeconds
|
||||
|
||||
# * @return string
|
||||
|
||||
# *
|
||||
|
||||
# * @named-arguments-supported'
|
||||
- name: handle
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
- name: next
|
||||
- name: redirectToRoute
|
||||
default: 'null'
|
||||
- name: passwordTimeoutSeconds
|
||||
default: 'null'
|
||||
comment: '# * Handle an incoming request.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param \Closure $next
|
||||
|
||||
# * @param string|null $redirectToRoute
|
||||
|
||||
# * @param string|int|null $passwordTimeoutSeconds
|
||||
|
||||
# * @return mixed'
|
||||
- name: shouldConfirmPassword
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: request
|
||||
- name: passwordTimeoutSeconds
|
||||
default: 'null'
|
||||
comment: '# * Determine if the confirmation timeout has expired.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param int|null $passwordTimeoutSeconds
|
||||
|
||||
# * @return bool'
|
||||
traits:
|
||||
- Closure
|
||||
- Illuminate\Contracts\Routing\ResponseFactory
|
||||
- Illuminate\Contracts\Routing\UrlGenerator
|
||||
interfaces: []
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
name: MustVerifyEmail
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: VerifyEmail
|
||||
type: class
|
||||
source: Illuminate\Auth\Notifications\VerifyEmail
|
||||
properties: []
|
||||
methods:
|
||||
- name: hasVerifiedEmail
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the user has verified their email address.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: markEmailAsVerified
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Mark the given user''s email as verified.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: sendEmailVerificationNotification
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Send the email verification notification.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: getEmailForVerification
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the email address that should be used for verification.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
traits:
|
||||
- Illuminate\Auth\Notifications\VerifyEmail
|
||||
interfaces: []
|
||||
|
|
@ -1,120 +0,0 @@
|
|||
name: ResetPassword
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: MailMessage
|
||||
type: class
|
||||
source: Illuminate\Notifications\Messages\MailMessage
|
||||
- name: Notification
|
||||
type: class
|
||||
source: Illuminate\Notifications\Notification
|
||||
- name: Lang
|
||||
type: class
|
||||
source: Illuminate\Support\Facades\Lang
|
||||
properties:
|
||||
- name: token
|
||||
visibility: public
|
||||
comment: '# * The password reset token.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: createUrlCallback
|
||||
visibility: public
|
||||
comment: '# * The callback that should be used to create the reset password URL.
|
||||
|
||||
# *
|
||||
|
||||
# * @var (\Closure(mixed, string): string)|null'
|
||||
- name: toMailCallback
|
||||
visibility: public
|
||||
comment: '# * The callback that should be used to build the mail message.
|
||||
|
||||
# *
|
||||
|
||||
# * @var (\Closure(mixed, string): \Illuminate\Notifications\Messages\MailMessage|\Illuminate\Contracts\Mail\Mailable)|null'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: token
|
||||
comment: "# * The password reset token.\n# *\n# * @var string\n# */\n# public $token;\n\
|
||||
# \n# /**\n# * The callback that should be used to create the reset password URL.\n\
|
||||
# *\n# * @var (\\Closure(mixed, string): string)|null\n# */\n# public static $createUrlCallback;\n\
|
||||
# \n# /**\n# * The callback that should be used to build the mail message.\n#\
|
||||
\ *\n# * @var (\\Closure(mixed, string): \\Illuminate\\Notifications\\Messages\\\
|
||||
MailMessage|\\Illuminate\\Contracts\\Mail\\Mailable)|null\n# */\n# public static\
|
||||
\ $toMailCallback;\n# \n# /**\n# * Create a notification instance.\n# *\n# * @param\
|
||||
\ string $token\n# * @return void"
|
||||
- name: via
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: notifiable
|
||||
comment: '# * Get the notification''s channels.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $notifiable
|
||||
|
||||
# * @return array|string'
|
||||
- name: toMail
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: notifiable
|
||||
comment: '# * Build the mail representation of the notification.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $notifiable
|
||||
|
||||
# * @return \Illuminate\Notifications\Messages\MailMessage'
|
||||
- name: buildMailMessage
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: url
|
||||
comment: '# * Get the reset password notification mail message for the given URL.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $url
|
||||
|
||||
# * @return \Illuminate\Notifications\Messages\MailMessage'
|
||||
- name: resetUrl
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: notifiable
|
||||
comment: '# * Get the reset URL for the given notifiable.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $notifiable
|
||||
|
||||
# * @return string'
|
||||
- name: createUrlUsing
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Set a callback that should be used when creating the reset password
|
||||
button URL.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Closure(mixed, string): string $callback
|
||||
|
||||
# * @return void'
|
||||
- name: toMailUsing
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Set a callback that should be used when building the notification
|
||||
mail message.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Closure(mixed, string): (\Illuminate\Notifications\Messages\MailMessage|\Illuminate\Contracts\Mail\Mailable) $callback
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Illuminate\Notifications\Messages\MailMessage
|
||||
- Illuminate\Notifications\Notification
|
||||
- Illuminate\Support\Facades\Lang
|
||||
interfaces: []
|
||||
|
|
@ -1,112 +0,0 @@
|
|||
name: VerifyEmail
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: MailMessage
|
||||
type: class
|
||||
source: Illuminate\Notifications\Messages\MailMessage
|
||||
- name: Notification
|
||||
type: class
|
||||
source: Illuminate\Notifications\Notification
|
||||
- name: Carbon
|
||||
type: class
|
||||
source: Illuminate\Support\Carbon
|
||||
- name: Config
|
||||
type: class
|
||||
source: Illuminate\Support\Facades\Config
|
||||
- name: Lang
|
||||
type: class
|
||||
source: Illuminate\Support\Facades\Lang
|
||||
- name: URL
|
||||
type: class
|
||||
source: Illuminate\Support\Facades\URL
|
||||
properties:
|
||||
- name: createUrlCallback
|
||||
visibility: public
|
||||
comment: '# * The callback that should be used to create the verify email URL.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Closure|null'
|
||||
- name: toMailCallback
|
||||
visibility: public
|
||||
comment: '# * The callback that should be used to build the mail message.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Closure|null'
|
||||
methods:
|
||||
- name: via
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: notifiable
|
||||
comment: "# * The callback that should be used to create the verify email URL.\n\
|
||||
# *\n# * @var \\Closure|null\n# */\n# public static $createUrlCallback;\n# \n\
|
||||
# /**\n# * The callback that should be used to build the mail message.\n# *\n\
|
||||
# * @var \\Closure|null\n# */\n# public static $toMailCallback;\n# \n# /**\n#\
|
||||
\ * Get the notification's channels.\n# *\n# * @param mixed $notifiable\n# *\
|
||||
\ @return array|string"
|
||||
- name: toMail
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: notifiable
|
||||
comment: '# * Build the mail representation of the notification.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $notifiable
|
||||
|
||||
# * @return \Illuminate\Notifications\Messages\MailMessage'
|
||||
- name: buildMailMessage
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: url
|
||||
comment: '# * Get the verify email notification mail message for the given URL.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $url
|
||||
|
||||
# * @return \Illuminate\Notifications\Messages\MailMessage'
|
||||
- name: verificationUrl
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: notifiable
|
||||
comment: '# * Get the verification URL for the given notifiable.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $notifiable
|
||||
|
||||
# * @return string'
|
||||
- name: createUrlUsing
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Set a callback that should be used when creating the email verification
|
||||
URL.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Closure $callback
|
||||
|
||||
# * @return void'
|
||||
- name: toMailUsing
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Set a callback that should be used when building the notification
|
||||
mail message.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Closure $callback
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Illuminate\Notifications\Messages\MailMessage
|
||||
- Illuminate\Notifications\Notification
|
||||
- Illuminate\Support\Carbon
|
||||
- Illuminate\Support\Facades\Config
|
||||
- Illuminate\Support\Facades\Lang
|
||||
- Illuminate\Support\Facades\URL
|
||||
interfaces: []
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
name: CanResetPassword
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: ResetPasswordNotification
|
||||
type: class
|
||||
source: Illuminate\Auth\Notifications\ResetPassword
|
||||
properties: []
|
||||
methods:
|
||||
- name: getEmailForPasswordReset
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the e-mail address where password reset links are sent.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: sendPasswordResetNotification
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: token
|
||||
comment: '# * Send the password reset notification.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $token
|
||||
|
||||
# * @return void'
|
||||
traits: []
|
||||
interfaces: []
|
||||
|
|
@ -1,226 +0,0 @@
|
|||
name: DatabaseTokenRepository
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: CanResetPasswordContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\CanResetPassword
|
||||
- name: HasherContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Hashing\Hasher
|
||||
- name: ConnectionInterface
|
||||
type: class
|
||||
source: Illuminate\Database\ConnectionInterface
|
||||
- name: Carbon
|
||||
type: class
|
||||
source: Illuminate\Support\Carbon
|
||||
- name: Str
|
||||
type: class
|
||||
source: Illuminate\Support\Str
|
||||
properties:
|
||||
- name: connection
|
||||
visibility: protected
|
||||
comment: '# * The database connection instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Database\ConnectionInterface'
|
||||
- name: hasher
|
||||
visibility: protected
|
||||
comment: '# * The Hasher implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Hashing\Hasher'
|
||||
- name: table
|
||||
visibility: protected
|
||||
comment: '# * The token database table.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: hashKey
|
||||
visibility: protected
|
||||
comment: '# * The hashing key.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: expires
|
||||
visibility: protected
|
||||
comment: '# * The number of seconds a token should last.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
- name: throttle
|
||||
visibility: protected
|
||||
comment: '# * Minimum number of seconds before re-redefining the token.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: connection
|
||||
- name: hasher
|
||||
- name: table
|
||||
- name: hashKey
|
||||
- name: expires
|
||||
default: '60'
|
||||
- name: throttle
|
||||
default: '60'
|
||||
comment: "# * The database connection instance.\n# *\n# * @var \\Illuminate\\Database\\\
|
||||
ConnectionInterface\n# */\n# protected $connection;\n# \n# /**\n# * The Hasher\
|
||||
\ implementation.\n# *\n# * @var \\Illuminate\\Contracts\\Hashing\\Hasher\n# */\n\
|
||||
# protected $hasher;\n# \n# /**\n# * The token database table.\n# *\n# * @var\
|
||||
\ string\n# */\n# protected $table;\n# \n# /**\n# * The hashing key.\n# *\n# *\
|
||||
\ @var string\n# */\n# protected $hashKey;\n# \n# /**\n# * The number of seconds\
|
||||
\ a token should last.\n# *\n# * @var int\n# */\n# protected $expires;\n# \n#\
|
||||
\ /**\n# * Minimum number of seconds before re-redefining the token.\n# *\n# *\
|
||||
\ @var int\n# */\n# protected $throttle;\n# \n# /**\n# * Create a new token repository\
|
||||
\ instance.\n# *\n# * @param \\Illuminate\\Database\\ConnectionInterface $connection\n\
|
||||
# * @param \\Illuminate\\Contracts\\Hashing\\Hasher $hasher\n# * @param string\
|
||||
\ $table\n# * @param string $hashKey\n# * @param int $expires\n# * @param\
|
||||
\ int $throttle\n# * @return void"
|
||||
- name: create
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Create a new token record.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\CanResetPassword $user
|
||||
|
||||
# * @return string'
|
||||
- name: deleteExisting
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Delete all existing reset tokens from the database.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\CanResetPassword $user
|
||||
|
||||
# * @return int'
|
||||
- name: getPayload
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: email
|
||||
- name: token
|
||||
comment: '# * Build the record payload for the table.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $email
|
||||
|
||||
# * @param string $token
|
||||
|
||||
# * @return array'
|
||||
- name: exists
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
- name: token
|
||||
comment: '# * Determine if a token record exists and is valid.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\CanResetPassword $user
|
||||
|
||||
# * @param string $token
|
||||
|
||||
# * @return bool'
|
||||
- name: tokenExpired
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: createdAt
|
||||
comment: '# * Determine if the token has expired.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $createdAt
|
||||
|
||||
# * @return bool'
|
||||
- name: recentlyCreatedToken
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Determine if the given user recently created a password reset token.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\CanResetPassword $user
|
||||
|
||||
# * @return bool'
|
||||
- name: tokenRecentlyCreated
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: createdAt
|
||||
comment: '# * Determine if the token was recently created.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $createdAt
|
||||
|
||||
# * @return bool'
|
||||
- name: delete
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Delete a token record by user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\CanResetPassword $user
|
||||
|
||||
# * @return void'
|
||||
- name: deleteExpired
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Delete expired tokens.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: createNewToken
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Create a new token for the user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: getConnection
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the database connection instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Database\ConnectionInterface'
|
||||
- name: getTable
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Begin a new database query against the table.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Database\Query\Builder'
|
||||
- name: getHasher
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the hasher instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Contracts\Hashing\Hasher'
|
||||
traits:
|
||||
- Illuminate\Database\ConnectionInterface
|
||||
- Illuminate\Support\Carbon
|
||||
- Illuminate\Support\Str
|
||||
interfaces:
|
||||
- TokenRepositoryInterface
|
||||
|
|
@ -1,174 +0,0 @@
|
|||
name: PasswordBroker
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: PasswordResetLinkSent
|
||||
type: class
|
||||
source: Illuminate\Auth\Events\PasswordResetLinkSent
|
||||
- name: CanResetPasswordContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\CanResetPassword
|
||||
- name: PasswordBrokerContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\PasswordBroker
|
||||
- name: UserProvider
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\UserProvider
|
||||
- name: Dispatcher
|
||||
type: class
|
||||
source: Illuminate\Contracts\Events\Dispatcher
|
||||
- name: Arr
|
||||
type: class
|
||||
source: Illuminate\Support\Arr
|
||||
- name: UnexpectedValueException
|
||||
type: class
|
||||
source: UnexpectedValueException
|
||||
properties:
|
||||
- name: tokens
|
||||
visibility: protected
|
||||
comment: '# * The password token repository.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Auth\Passwords\TokenRepositoryInterface'
|
||||
- name: users
|
||||
visibility: protected
|
||||
comment: '# * The user provider implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Auth\UserProvider'
|
||||
- name: events
|
||||
visibility: protected
|
||||
comment: '# * The event dispatcher instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Events\Dispatcher'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: tokens
|
||||
- name: users
|
||||
- name: dispatcher
|
||||
default: 'null'
|
||||
comment: "# * The password token repository.\n# *\n# * @var \\Illuminate\\Auth\\\
|
||||
Passwords\\TokenRepositoryInterface\n# */\n# protected $tokens;\n# \n# /**\n#\
|
||||
\ * The user provider implementation.\n# *\n# * @var \\Illuminate\\Contracts\\\
|
||||
Auth\\UserProvider\n# */\n# protected $users;\n# \n# /**\n# * The event dispatcher\
|
||||
\ instance.\n# *\n# * @var \\Illuminate\\Contracts\\Events\\Dispatcher\n# */\n\
|
||||
# protected $events;\n# \n# /**\n# * Create a new password broker instance.\n\
|
||||
# *\n# * @param \\Illuminate\\Auth\\Passwords\\TokenRepositoryInterface $tokens\n\
|
||||
# * @param \\Illuminate\\Contracts\\Auth\\UserProvider $users\n# * @param \\\
|
||||
Illuminate\\Contracts\\Events\\Dispatcher|null $dispatcher\n# * @return void"
|
||||
- name: sendResetLink
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: credentials
|
||||
- name: callback
|
||||
default: 'null'
|
||||
comment: '# * Send a password reset link to a user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @param \Closure|null $callback
|
||||
|
||||
# * @return string'
|
||||
- name: reset
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: credentials
|
||||
- name: callback
|
||||
comment: '# * Reset the password for the given token.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @param \Closure $callback
|
||||
|
||||
# * @return mixed'
|
||||
- name: validateReset
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: credentials
|
||||
comment: '# * Validate a password reset for the given credentials.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\CanResetPassword|string'
|
||||
- name: getUser
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: credentials
|
||||
comment: '# * Get the user for the given credentials.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\CanResetPassword|null
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \UnexpectedValueException'
|
||||
- name: createToken
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Create a new password reset token for the given user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\CanResetPassword $user
|
||||
|
||||
# * @return string'
|
||||
- name: deleteToken
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Delete password reset tokens of the given user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\CanResetPassword $user
|
||||
|
||||
# * @return void'
|
||||
- name: tokenExists
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
- name: token
|
||||
comment: '# * Validate the given password reset token.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\CanResetPassword $user
|
||||
|
||||
# * @param string $token
|
||||
|
||||
# * @return bool'
|
||||
- name: getRepository
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the password reset token repository implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Auth\Passwords\TokenRepositoryInterface'
|
||||
traits:
|
||||
- Closure
|
||||
- Illuminate\Auth\Events\PasswordResetLinkSent
|
||||
- Illuminate\Contracts\Auth\UserProvider
|
||||
- Illuminate\Contracts\Events\Dispatcher
|
||||
- Illuminate\Support\Arr
|
||||
- UnexpectedValueException
|
||||
interfaces:
|
||||
- PasswordBrokerContract
|
||||
|
|
@ -1,132 +0,0 @@
|
|||
name: PasswordBrokerManager
|
||||
class_comment: '# * @mixin \Illuminate\Contracts\Auth\PasswordBroker'
|
||||
dependencies:
|
||||
- name: FactoryContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\PasswordBrokerFactory
|
||||
- name: InvalidArgumentException
|
||||
type: class
|
||||
source: InvalidArgumentException
|
||||
properties:
|
||||
- name: app
|
||||
visibility: protected
|
||||
comment: '# * @mixin \Illuminate\Contracts\Auth\PasswordBroker
|
||||
|
||||
# */
|
||||
|
||||
# class PasswordBrokerManager implements FactoryContract
|
||||
|
||||
# {
|
||||
|
||||
# /**
|
||||
|
||||
# * The application instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Foundation\Application'
|
||||
- name: brokers
|
||||
visibility: protected
|
||||
comment: '# * The array of created "drivers".
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: app
|
||||
comment: "# * @mixin \\Illuminate\\Contracts\\Auth\\PasswordBroker\n# */\n# class\
|
||||
\ PasswordBrokerManager implements FactoryContract\n# {\n# /**\n# * The application\
|
||||
\ instance.\n# *\n# * @var \\Illuminate\\Contracts\\Foundation\\Application\n\
|
||||
# */\n# protected $app;\n# \n# /**\n# * The array of created \"drivers\".\n# *\n\
|
||||
# * @var array\n# */\n# protected $brokers = [];\n# \n# /**\n# * Create a new\
|
||||
\ PasswordBroker manager instance.\n# *\n# * @param \\Illuminate\\Contracts\\\
|
||||
Foundation\\Application $app\n# * @return void"
|
||||
- name: broker
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
default: 'null'
|
||||
comment: '# * Attempt to get the broker from the local cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $name
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\PasswordBroker'
|
||||
- name: resolve
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Resolve the given broker.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\PasswordBroker
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \InvalidArgumentException'
|
||||
- name: createTokenRepository
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: config
|
||||
comment: '# * Create a token repository instance based on the given configuration.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return \Illuminate\Auth\Passwords\TokenRepositoryInterface'
|
||||
- name: getConfig
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Get the password broker configuration.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @return array|null'
|
||||
- name: getDefaultDriver
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the default password broker name.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: setDefaultDriver
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Set the default password broker name.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @return void'
|
||||
- name: __call
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: method
|
||||
- name: parameters
|
||||
comment: '# * Dynamically call the default driver instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $method
|
||||
|
||||
# * @param array $parameters
|
||||
|
||||
# * @return mixed'
|
||||
traits:
|
||||
- InvalidArgumentException
|
||||
interfaces:
|
||||
- FactoryContract
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
name: PasswordResetServiceProvider
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: DeferrableProvider
|
||||
type: class
|
||||
source: Illuminate\Contracts\Support\DeferrableProvider
|
||||
- name: ServiceProvider
|
||||
type: class
|
||||
source: Illuminate\Support\ServiceProvider
|
||||
properties: []
|
||||
methods:
|
||||
- name: register
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Register the service provider.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: registerPasswordBroker
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Register the password broker instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: provides
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the services provided by the provider.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
traits:
|
||||
- Illuminate\Contracts\Support\DeferrableProvider
|
||||
- Illuminate\Support\ServiceProvider
|
||||
interfaces:
|
||||
- DeferrableProvider
|
||||
|
|
@ -1,65 +0,0 @@
|
|||
name: TokenRepositoryInterface
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: CanResetPasswordContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\CanResetPassword
|
||||
properties: []
|
||||
methods:
|
||||
- name: create
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Create a new token.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\CanResetPassword $user
|
||||
|
||||
# * @return string'
|
||||
- name: exists
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
- name: token
|
||||
comment: '# * Determine if a token record exists and is valid.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\CanResetPassword $user
|
||||
|
||||
# * @param string $token
|
||||
|
||||
# * @return bool'
|
||||
- name: recentlyCreatedToken
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Determine if the given user recently created a password reset token.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\CanResetPassword $user
|
||||
|
||||
# * @return bool'
|
||||
- name: delete
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Delete a token record.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\CanResetPassword $user
|
||||
|
||||
# * @return void'
|
||||
- name: deleteExpired
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Delete expired tokens.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
traits: []
|
||||
interfaces: []
|
||||
|
|
@ -1,77 +0,0 @@
|
|||
name: Recaller
|
||||
class_comment: null
|
||||
dependencies: []
|
||||
properties:
|
||||
- name: recaller
|
||||
visibility: protected
|
||||
comment: '# * The "recaller" / "remember me" cookie string.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: recaller
|
||||
comment: "# * The \"recaller\" / \"remember me\" cookie string.\n# *\n# * @var string\n\
|
||||
# */\n# protected $recaller;\n# \n# /**\n# * Create a new recaller instance.\n\
|
||||
# *\n# * @param string $recaller\n# * @return void"
|
||||
- name: id
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the user ID from the recaller.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: token
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the "remember token" token from the recaller.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: hash
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the password from the recaller.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: valid
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the recaller is valid.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: properString
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Determine if the recaller is an invalid string.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: hasAllSegments
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Determine if the recaller has all segments.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: segments
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the recaller''s segments.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
traits: []
|
||||
interfaces: []
|
||||
|
|
@ -1,83 +0,0 @@
|
|||
name: RequestGuard
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Guard
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Guard
|
||||
- name: UserProvider
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\UserProvider
|
||||
- name: Request
|
||||
type: class
|
||||
source: Illuminate\Http\Request
|
||||
- name: Macroable
|
||||
type: class
|
||||
source: Illuminate\Support\Traits\Macroable
|
||||
properties:
|
||||
- name: callback
|
||||
visibility: protected
|
||||
comment: '# * The guard callback.
|
||||
|
||||
# *
|
||||
|
||||
# * @var callable'
|
||||
- name: request
|
||||
visibility: protected
|
||||
comment: '# * The request instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Http\Request'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
- name: request
|
||||
- name: provider
|
||||
default: 'null'
|
||||
comment: "# * The guard callback.\n# *\n# * @var callable\n# */\n# protected $callback;\n\
|
||||
# \n# /**\n# * The request instance.\n# *\n# * @var \\Illuminate\\Http\\Request\n\
|
||||
# */\n# protected $request;\n# \n# /**\n# * Create a new authentication guard.\n\
|
||||
# *\n# * @param callable $callback\n# * @param \\Illuminate\\Http\\Request\
|
||||
\ $request\n# * @param \\Illuminate\\Contracts\\Auth\\UserProvider|null $provider\n\
|
||||
# * @return void"
|
||||
- name: user
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the currently authenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
|
||||
- name: validate
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: credentials
|
||||
default: '[]'
|
||||
comment: '# * Validate a user''s credentials.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @return bool'
|
||||
- name: setRequest
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
comment: '# * Set the current request instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @return $this'
|
||||
traits:
|
||||
- Illuminate\Contracts\Auth\Guard
|
||||
- Illuminate\Contracts\Auth\UserProvider
|
||||
- Illuminate\Http\Request
|
||||
- Illuminate\Support\Traits\Macroable
|
||||
- GuardHelpers
|
||||
interfaces:
|
||||
- Guard
|
||||
|
|
@ -1,834 +0,0 @@
|
|||
name: SessionGuard
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Attempting
|
||||
type: class
|
||||
source: Illuminate\Auth\Events\Attempting
|
||||
- name: Authenticated
|
||||
type: class
|
||||
source: Illuminate\Auth\Events\Authenticated
|
||||
- name: CurrentDeviceLogout
|
||||
type: class
|
||||
source: Illuminate\Auth\Events\CurrentDeviceLogout
|
||||
- name: Failed
|
||||
type: class
|
||||
source: Illuminate\Auth\Events\Failed
|
||||
- name: Login
|
||||
type: class
|
||||
source: Illuminate\Auth\Events\Login
|
||||
- name: Logout
|
||||
type: class
|
||||
source: Illuminate\Auth\Events\Logout
|
||||
- name: OtherDeviceLogout
|
||||
type: class
|
||||
source: Illuminate\Auth\Events\OtherDeviceLogout
|
||||
- name: Validated
|
||||
type: class
|
||||
source: Illuminate\Auth\Events\Validated
|
||||
- name: AuthenticatableContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Authenticatable
|
||||
- name: StatefulGuard
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\StatefulGuard
|
||||
- name: SupportsBasicAuth
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\SupportsBasicAuth
|
||||
- name: UserProvider
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\UserProvider
|
||||
- name: CookieJar
|
||||
type: class
|
||||
source: Illuminate\Contracts\Cookie\QueueingFactory
|
||||
- name: Dispatcher
|
||||
type: class
|
||||
source: Illuminate\Contracts\Events\Dispatcher
|
||||
- name: Session
|
||||
type: class
|
||||
source: Illuminate\Contracts\Session\Session
|
||||
- name: Arr
|
||||
type: class
|
||||
source: Illuminate\Support\Arr
|
||||
- name: Hash
|
||||
type: class
|
||||
source: Illuminate\Support\Facades\Hash
|
||||
- name: Str
|
||||
type: class
|
||||
source: Illuminate\Support\Str
|
||||
- name: Timebox
|
||||
type: class
|
||||
source: Illuminate\Support\Timebox
|
||||
- name: Macroable
|
||||
type: class
|
||||
source: Illuminate\Support\Traits\Macroable
|
||||
- name: InvalidArgumentException
|
||||
type: class
|
||||
source: InvalidArgumentException
|
||||
- name: RuntimeException
|
||||
type: class
|
||||
source: RuntimeException
|
||||
- name: Request
|
||||
type: class
|
||||
source: Symfony\Component\HttpFoundation\Request
|
||||
- name: UnauthorizedHttpException
|
||||
type: class
|
||||
source: Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException
|
||||
properties:
|
||||
- name: lastAttempted
|
||||
visibility: protected
|
||||
comment: "# * The name of the guard. Typically \"web\".\n# *\n# * Corresponds to\
|
||||
\ guard name in authentication configuration.\n# *\n# * @var string\n# */\n# public\
|
||||
\ readonly string $name;\n# \n# /**\n# * The user we last attempted to retrieve.\n\
|
||||
# *\n# * @var \\Illuminate\\Contracts\\Auth\\Authenticatable"
|
||||
- name: viaRemember
|
||||
visibility: protected
|
||||
comment: '# * Indicates if the user was authenticated via a recaller cookie.
|
||||
|
||||
# *
|
||||
|
||||
# * @var bool'
|
||||
- name: rememberDuration
|
||||
visibility: protected
|
||||
comment: '# * The number of minutes that the "remember me" cookie should be valid
|
||||
for.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
- name: session
|
||||
visibility: protected
|
||||
comment: '# * The session used by the guard.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Session\Session'
|
||||
- name: cookie
|
||||
visibility: protected
|
||||
comment: '# * The Illuminate cookie creator service.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Cookie\QueueingFactory'
|
||||
- name: request
|
||||
visibility: protected
|
||||
comment: '# * The request instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Symfony\Component\HttpFoundation\Request'
|
||||
- name: events
|
||||
visibility: protected
|
||||
comment: '# * The event dispatcher instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Events\Dispatcher'
|
||||
- name: timebox
|
||||
visibility: protected
|
||||
comment: '# * The timebox instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Support\Timebox'
|
||||
- name: rehashOnLogin
|
||||
visibility: protected
|
||||
comment: '# * Indicates if passwords should be rehashed on login if needed.
|
||||
|
||||
# *
|
||||
|
||||
# * @var bool'
|
||||
- name: loggedOut
|
||||
visibility: protected
|
||||
comment: '# * Indicates if the logout method has been called.
|
||||
|
||||
# *
|
||||
|
||||
# * @var bool'
|
||||
- name: recallAttempted
|
||||
visibility: protected
|
||||
comment: '# * Indicates if a token user retrieval has been attempted.
|
||||
|
||||
# *
|
||||
|
||||
# * @var bool'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
- name: provider
|
||||
- name: session
|
||||
- name: request
|
||||
default: 'null'
|
||||
- name: timebox
|
||||
default: 'null'
|
||||
- name: rehashOnLogin
|
||||
default: 'true'
|
||||
comment: "# * The name of the guard. Typically \"web\".\n# *\n# * Corresponds to\
|
||||
\ guard name in authentication configuration.\n# *\n# * @var string\n# */\n# public\
|
||||
\ readonly string $name;\n# \n# /**\n# * The user we last attempted to retrieve.\n\
|
||||
# *\n# * @var \\Illuminate\\Contracts\\Auth\\Authenticatable\n# */\n# protected\
|
||||
\ $lastAttempted;\n# \n# /**\n# * Indicates if the user was authenticated via\
|
||||
\ a recaller cookie.\n# *\n# * @var bool\n# */\n# protected $viaRemember = false;\n\
|
||||
# \n# /**\n# * The number of minutes that the \"remember me\" cookie should be\
|
||||
\ valid for.\n# *\n# * @var int\n# */\n# protected $rememberDuration = 576000;\n\
|
||||
# \n# /**\n# * The session used by the guard.\n# *\n# * @var \\Illuminate\\Contracts\\\
|
||||
Session\\Session\n# */\n# protected $session;\n# \n# /**\n# * The Illuminate cookie\
|
||||
\ creator service.\n# *\n# * @var \\Illuminate\\Contracts\\Cookie\\QueueingFactory\n\
|
||||
# */\n# protected $cookie;\n# \n# /**\n# * The request instance.\n# *\n# * @var\
|
||||
\ \\Symfony\\Component\\HttpFoundation\\Request\n# */\n# protected $request;\n\
|
||||
# \n# /**\n# * The event dispatcher instance.\n# *\n# * @var \\Illuminate\\Contracts\\\
|
||||
Events\\Dispatcher\n# */\n# protected $events;\n# \n# /**\n# * The timebox instance.\n\
|
||||
# *\n# * @var \\Illuminate\\Support\\Timebox\n# */\n# protected $timebox;\n# \n\
|
||||
# /**\n# * Indicates if passwords should be rehashed on login if needed.\n# *\n\
|
||||
# * @var bool\n# */\n# protected $rehashOnLogin;\n# \n# /**\n# * Indicates if\
|
||||
\ the logout method has been called.\n# *\n# * @var bool\n# */\n# protected $loggedOut\
|
||||
\ = false;\n# \n# /**\n# * Indicates if a token user retrieval has been attempted.\n\
|
||||
# *\n# * @var bool\n# */\n# protected $recallAttempted = false;\n# \n# /**\n#\
|
||||
\ * Create a new authentication guard.\n# *\n# * @param string $name\n# * @param\
|
||||
\ \\Illuminate\\Contracts\\Auth\\UserProvider $provider\n# * @param \\Illuminate\\\
|
||||
Contracts\\Session\\Session $session\n# * @param \\Symfony\\Component\\HttpFoundation\\\
|
||||
Request|null $request\n# * @param \\Illuminate\\Support\\Timebox|null $timebox\n\
|
||||
# * @param bool $rehashOnLogin\n# * @return void"
|
||||
- name: user
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the currently authenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
|
||||
- name: userFromRecaller
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: recaller
|
||||
comment: '# * Pull a user from the repository by its "remember me" cookie token.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Auth\Recaller $recaller
|
||||
|
||||
# * @return mixed'
|
||||
- name: recaller
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Get the decrypted recaller cookie for the request.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Auth\Recaller|null'
|
||||
- name: id
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the ID for the currently authenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return int|string|null'
|
||||
- name: once
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: credentials
|
||||
default: '[]'
|
||||
comment: '# * Log a user into the application without sessions or cookies.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @return bool'
|
||||
- name: onceUsingId
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: id
|
||||
comment: '# * Log the given user ID into the application without sessions or cookies.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $id
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable|false'
|
||||
- name: validate
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: credentials
|
||||
default: '[]'
|
||||
comment: '# * Validate a user''s credentials.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @return bool'
|
||||
- name: basic
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: field
|
||||
default: '''email'''
|
||||
- name: extraConditions
|
||||
default: '[]'
|
||||
comment: '# * Attempt to authenticate using HTTP Basic Auth.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $field
|
||||
|
||||
# * @param array $extraConditions
|
||||
|
||||
# * @return \Symfony\Component\HttpFoundation\Response|null
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException'
|
||||
- name: onceBasic
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: field
|
||||
default: '''email'''
|
||||
- name: extraConditions
|
||||
default: '[]'
|
||||
comment: '# * Perform a stateless HTTP Basic login attempt.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $field
|
||||
|
||||
# * @param array $extraConditions
|
||||
|
||||
# * @return \Symfony\Component\HttpFoundation\Response|null
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException'
|
||||
- name: attemptBasic
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: request
|
||||
- name: field
|
||||
- name: extraConditions
|
||||
default: '[]'
|
||||
comment: '# * Attempt to authenticate using basic authentication.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Symfony\Component\HttpFoundation\Request $request
|
||||
|
||||
# * @param string $field
|
||||
|
||||
# * @param array $extraConditions
|
||||
|
||||
# * @return bool'
|
||||
- name: basicCredentials
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: request
|
||||
- name: field
|
||||
comment: '# * Get the credential array for an HTTP Basic request.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Symfony\Component\HttpFoundation\Request $request
|
||||
|
||||
# * @param string $field
|
||||
|
||||
# * @return array'
|
||||
- name: failedBasicResponse
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Get the response for basic authentication.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException'
|
||||
- name: attempt
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: credentials
|
||||
default: '[]'
|
||||
- name: remember
|
||||
default: 'false'
|
||||
comment: '# * Attempt to authenticate a user using the given credentials.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @param bool $remember
|
||||
|
||||
# * @return bool'
|
||||
- name: attemptWhen
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: credentials
|
||||
default: '[]'
|
||||
- name: callbacks
|
||||
default: 'null'
|
||||
- name: remember
|
||||
default: 'false'
|
||||
comment: '# * Attempt to authenticate a user with credentials and additional callbacks.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @param array|callable|null $callbacks
|
||||
|
||||
# * @param bool $remember
|
||||
|
||||
# * @return bool'
|
||||
- name: hasValidCredentials
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
- name: credentials
|
||||
comment: '# * Determine if the user matches the credentials.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $user
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @return bool'
|
||||
- name: shouldLogin
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: callbacks
|
||||
- name: user
|
||||
comment: '# * Determine if the user should login by executing the given callbacks.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array|callable|null $callbacks
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @return bool'
|
||||
- name: rehashPasswordIfRequired
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
- name: credentials
|
||||
comment: '# * Rehash the user''s password if enabled and required.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @return void'
|
||||
- name: loginUsingId
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: id
|
||||
- name: remember
|
||||
default: 'false'
|
||||
comment: '# * Log the given user ID into the application.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $id
|
||||
|
||||
# * @param bool $remember
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable|false'
|
||||
- name: login
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
- name: remember
|
||||
default: 'false'
|
||||
comment: '# * Log a user into the application.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @param bool $remember
|
||||
|
||||
# * @return void'
|
||||
- name: updateSession
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: id
|
||||
comment: '# * Update the session with the given ID.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $id
|
||||
|
||||
# * @return void'
|
||||
- name: ensureRememberTokenIsSet
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Create a new "remember me" token for the user if one doesn''t already
|
||||
exist.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @return void'
|
||||
- name: queueRecallerCookie
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Queue the recaller cookie into the cookie jar.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @return void'
|
||||
- name: createRecaller
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: value
|
||||
comment: '# * Create a "remember me" cookie for a given ID.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $value
|
||||
|
||||
# * @return \Symfony\Component\HttpFoundation\Cookie'
|
||||
- name: logout
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Log the user out of the application.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: logoutCurrentDevice
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Log the user out of the application on their current device only.
|
||||
|
||||
# *
|
||||
|
||||
# * This method does not cycle the "remember" token.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: clearUserDataFromStorage
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Remove the user data from the session and cookies.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: cycleRememberToken
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Refresh the "remember me" token for the user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @return void'
|
||||
- name: logoutOtherDevices
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: password
|
||||
comment: '# * Invalidate other sessions for the current user.
|
||||
|
||||
# *
|
||||
|
||||
# * The application must be using the AuthenticateSession middleware.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $password
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable|null
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Auth\AuthenticationException'
|
||||
- name: rehashUserPasswordForDeviceLogout
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: password
|
||||
comment: '# * Rehash the current user''s password for logging out other devices
|
||||
via AuthenticateSession.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $password
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable|null
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \InvalidArgumentException'
|
||||
- name: attempting
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Register an authentication attempt event listener.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $callback
|
||||
|
||||
# * @return void'
|
||||
- name: fireAttemptEvent
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: credentials
|
||||
- name: remember
|
||||
default: 'false'
|
||||
comment: '# * Fire the attempt event with the arguments.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @param bool $remember
|
||||
|
||||
# * @return void'
|
||||
- name: fireValidatedEvent
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Fires the validated event if the dispatcher is set.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @return void'
|
||||
- name: fireLoginEvent
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
- name: remember
|
||||
default: 'false'
|
||||
comment: '# * Fire the login event if the dispatcher is set.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @param bool $remember
|
||||
|
||||
# * @return void'
|
||||
- name: fireAuthenticatedEvent
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Fire the authenticated event if the dispatcher is set.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @return void'
|
||||
- name: fireOtherDeviceLogoutEvent
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Fire the other device logout event if the dispatcher is set.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @return void'
|
||||
- name: fireFailedEvent
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: user
|
||||
- name: credentials
|
||||
comment: '# * Fire the failed authentication attempt event with the given arguments.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable|null $user
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @return void'
|
||||
- name: getLastAttempted
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the last user we attempted to authenticate.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable'
|
||||
- name: getName
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get a unique identifier for the auth session value.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: getRecallerName
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the name of the cookie used to store the "recaller".
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: viaRemember
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the user was authenticated via "remember me" cookie.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: getRememberDuration
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Get the number of minutes the remember me cookie should be valid for.
|
||||
|
||||
# *
|
||||
|
||||
# * @return int'
|
||||
- name: setRememberDuration
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: minutes
|
||||
comment: '# * Set the number of minutes the remember me cookie should be valid for.
|
||||
|
||||
# *
|
||||
|
||||
# * @param int $minutes
|
||||
|
||||
# * @return $this'
|
||||
- name: getCookieJar
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the cookie creator instance used by the guard.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Contracts\Cookie\QueueingFactory
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \RuntimeException'
|
||||
- name: setCookieJar
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: cookie
|
||||
comment: '# * Set the cookie creator instance used by the guard.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Cookie\QueueingFactory $cookie
|
||||
|
||||
# * @return void'
|
||||
- name: getDispatcher
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the event dispatcher instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Contracts\Events\Dispatcher'
|
||||
- name: setDispatcher
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: events
|
||||
comment: '# * Set the event dispatcher instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Events\Dispatcher $events
|
||||
|
||||
# * @return void'
|
||||
- name: getSession
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the session store used by the guard.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Contracts\Session\Session'
|
||||
- name: getUser
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Return the currently cached user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
|
||||
- name: setUser
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: user
|
||||
comment: '# * Set the current user.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||||
|
||||
# * @return $this'
|
||||
- name: getRequest
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the current request instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Symfony\Component\HttpFoundation\Request'
|
||||
- name: setRequest
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
comment: '# * Set the current request instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Symfony\Component\HttpFoundation\Request $request
|
||||
|
||||
# * @return $this'
|
||||
- name: getTimebox
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the timebox instance used by the guard.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Support\Timebox'
|
||||
traits:
|
||||
- Illuminate\Auth\Events\Attempting
|
||||
- Illuminate\Auth\Events\Authenticated
|
||||
- Illuminate\Auth\Events\CurrentDeviceLogout
|
||||
- Illuminate\Auth\Events\Failed
|
||||
- Illuminate\Auth\Events\Login
|
||||
- Illuminate\Auth\Events\Logout
|
||||
- Illuminate\Auth\Events\OtherDeviceLogout
|
||||
- Illuminate\Auth\Events\Validated
|
||||
- Illuminate\Contracts\Auth\StatefulGuard
|
||||
- Illuminate\Contracts\Auth\SupportsBasicAuth
|
||||
- Illuminate\Contracts\Auth\UserProvider
|
||||
- Illuminate\Contracts\Events\Dispatcher
|
||||
- Illuminate\Contracts\Session\Session
|
||||
- Illuminate\Support\Arr
|
||||
- Illuminate\Support\Facades\Hash
|
||||
- Illuminate\Support\Str
|
||||
- Illuminate\Support\Timebox
|
||||
- Illuminate\Support\Traits\Macroable
|
||||
- InvalidArgumentException
|
||||
- RuntimeException
|
||||
- Symfony\Component\HttpFoundation\Request
|
||||
- Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException
|
||||
- GuardHelpers
|
||||
interfaces:
|
||||
- StatefulGuard
|
||||
|
|
@ -1,114 +0,0 @@
|
|||
name: TokenGuard
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Guard
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\Guard
|
||||
- name: UserProvider
|
||||
type: class
|
||||
source: Illuminate\Contracts\Auth\UserProvider
|
||||
- name: Request
|
||||
type: class
|
||||
source: Illuminate\Http\Request
|
||||
- name: Macroable
|
||||
type: class
|
||||
source: Illuminate\Support\Traits\Macroable
|
||||
properties:
|
||||
- name: request
|
||||
visibility: protected
|
||||
comment: '# * The request instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Http\Request'
|
||||
- name: inputKey
|
||||
visibility: protected
|
||||
comment: '# * The name of the query string item from the request containing the
|
||||
API token.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: storageKey
|
||||
visibility: protected
|
||||
comment: '# * The name of the token "column" in persistent storage.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: hash
|
||||
visibility: protected
|
||||
comment: '# * Indicates if the API token is hashed in storage.
|
||||
|
||||
# *
|
||||
|
||||
# * @var bool'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: provider
|
||||
- name: request
|
||||
- name: inputKey
|
||||
default: '''api_token'''
|
||||
- name: storageKey
|
||||
default: '''api_token'''
|
||||
- name: hash
|
||||
default: 'false'
|
||||
comment: "# * The request instance.\n# *\n# * @var \\Illuminate\\Http\\Request\n\
|
||||
# */\n# protected $request;\n# \n# /**\n# * The name of the query string item\
|
||||
\ from the request containing the API token.\n# *\n# * @var string\n# */\n# protected\
|
||||
\ $inputKey;\n# \n# /**\n# * The name of the token \"column\" in persistent storage.\n\
|
||||
# *\n# * @var string\n# */\n# protected $storageKey;\n# \n# /**\n# * Indicates\
|
||||
\ if the API token is hashed in storage.\n# *\n# * @var bool\n# */\n# protected\
|
||||
\ $hash = false;\n# \n# /**\n# * Create a new authentication guard.\n# *\n# *\
|
||||
\ @param \\Illuminate\\Contracts\\Auth\\UserProvider $provider\n# * @param \
|
||||
\ \\Illuminate\\Http\\Request $request\n# * @param string $inputKey\n# * @param\
|
||||
\ string $storageKey\n# * @param bool $hash\n# * @return void"
|
||||
- name: user
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the currently authenticated user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
|
||||
- name: getTokenForRequest
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the token for the current request.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string|null'
|
||||
- name: validate
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: credentials
|
||||
default: '[]'
|
||||
comment: '# * Validate a user''s credentials.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $credentials
|
||||
|
||||
# * @return bool'
|
||||
- name: setRequest
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
comment: '# * Set the current request instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @return $this'
|
||||
traits:
|
||||
- Illuminate\Contracts\Auth\Guard
|
||||
- Illuminate\Contracts\Auth\UserProvider
|
||||
- Illuminate\Http\Request
|
||||
- Illuminate\Support\Traits\Macroable
|
||||
- GuardHelpers
|
||||
interfaces:
|
||||
- Guard
|
||||
|
|
@ -1,89 +0,0 @@
|
|||
name: AnonymousEvent
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: ShouldBroadcast
|
||||
type: class
|
||||
source: Illuminate\Contracts\Broadcasting\ShouldBroadcast
|
||||
- name: Arrayable
|
||||
type: class
|
||||
source: Illuminate\Contracts\Support\Arrayable
|
||||
- name: Dispatchable
|
||||
type: class
|
||||
source: Illuminate\Foundation\Events\Dispatchable
|
||||
- name: Arr
|
||||
type: class
|
||||
source: Illuminate\Support\Arr
|
||||
properties: []
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channels
|
||||
comment: "# * The connection the event should be broadcast on.\n# */\n# protected\
|
||||
\ ?string $connection = null;\n# \n# /**\n# * The name the event should be broadcast\
|
||||
\ as.\n# */\n# protected ?string $name = null;\n# \n# /**\n# * The payload the\
|
||||
\ event should be broadcast with.\n# */\n# protected array $payload = [];\n# \n\
|
||||
# /**\n# * Should the broadcast include the current user.\n# */\n# protected bool\
|
||||
\ $includeCurrentUser = true;\n# \n# /**\n# * Indicates if the event should be\
|
||||
\ broadcast synchronously.\n# */\n# protected bool $shouldBroadcastNow = false;\n\
|
||||
# \n# /**\n# * Create a new anonymous broadcastable event instance.\n# *\n# *\
|
||||
\ @return void"
|
||||
- name: via
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: connection
|
||||
comment: '# * Set the connection the event should be broadcast on.'
|
||||
- name: as
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Set the name the event should be broadcast as.'
|
||||
- name: with
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: payload
|
||||
comment: '# * Set the payload the event should be broadcast with.'
|
||||
- name: toOthers
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Broadcast the event to everyone except the current user.'
|
||||
- name: sendNow
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Broadcast the event.'
|
||||
- name: send
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Broadcast the event.'
|
||||
- name: broadcastAs
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the name the event should broadcast as.'
|
||||
- name: broadcastWith
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the payload the event should broadcast with.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array<string, mixed>'
|
||||
- name: broadcastOn
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the channels the event should broadcast on.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Broadcasting\Channel|\Illuminate\Broadcasting\Channel[]|string[]|string'
|
||||
- name: shouldBroadcastNow
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the event should be broadcast synchronously.'
|
||||
traits:
|
||||
- Illuminate\Contracts\Broadcasting\ShouldBroadcast
|
||||
- Illuminate\Contracts\Support\Arrayable
|
||||
- Illuminate\Foundation\Events\Dispatchable
|
||||
- Illuminate\Support\Arr
|
||||
- Dispatchable
|
||||
interfaces:
|
||||
- ShouldBroadcast
|
||||
|
|
@ -1,49 +0,0 @@
|
|||
name: BroadcastController
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Request
|
||||
type: class
|
||||
source: Illuminate\Http\Request
|
||||
- name: Controller
|
||||
type: class
|
||||
source: Illuminate\Routing\Controller
|
||||
- name: Broadcast
|
||||
type: class
|
||||
source: Illuminate\Support\Facades\Broadcast
|
||||
- name: AccessDeniedHttpException
|
||||
type: class
|
||||
source: Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
|
||||
properties: []
|
||||
methods:
|
||||
- name: authenticate
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
comment: '# * Authenticate the request for channel access.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @return \Illuminate\Http\Response'
|
||||
- name: authenticateUser
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
comment: '# * Authenticate the current user.
|
||||
|
||||
# *
|
||||
|
||||
# * See: https://pusher.com/docs/channels/server_api/authenticating-users/#user-authentication.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @return \Illuminate\Http\Response'
|
||||
traits:
|
||||
- Illuminate\Http\Request
|
||||
- Illuminate\Routing\Controller
|
||||
- Illuminate\Support\Facades\Broadcast
|
||||
- Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
|
||||
interfaces: []
|
||||
|
|
@ -1,137 +0,0 @@
|
|||
name: BroadcastEvent
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Queueable
|
||||
type: class
|
||||
source: Illuminate\Bus\Queueable
|
||||
- name: BroadcastingFactory
|
||||
type: class
|
||||
source: Illuminate\Contracts\Broadcasting\Factory
|
||||
- name: ShouldQueue
|
||||
type: class
|
||||
source: Illuminate\Contracts\Queue\ShouldQueue
|
||||
- name: Arrayable
|
||||
type: class
|
||||
source: Illuminate\Contracts\Support\Arrayable
|
||||
- name: Arr
|
||||
type: class
|
||||
source: Illuminate\Support\Arr
|
||||
- name: ReflectionClass
|
||||
type: class
|
||||
source: ReflectionClass
|
||||
- name: ReflectionProperty
|
||||
type: class
|
||||
source: ReflectionProperty
|
||||
- name: Queueable
|
||||
type: class
|
||||
source: Queueable
|
||||
properties:
|
||||
- name: event
|
||||
visibility: public
|
||||
comment: '# * The event instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var mixed'
|
||||
- name: tries
|
||||
visibility: public
|
||||
comment: '# * The number of times the job may be attempted.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
- name: timeout
|
||||
visibility: public
|
||||
comment: '# * The number of seconds the job can run before timing out.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
- name: backoff
|
||||
visibility: public
|
||||
comment: '# * The number of seconds to wait before retrying the job when encountering
|
||||
an uncaught exception.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
- name: maxExceptions
|
||||
visibility: public
|
||||
comment: '# * The maximum number of unhandled exceptions to allow before failing.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: event
|
||||
comment: "# * The event instance.\n# *\n# * @var mixed\n# */\n# public $event;\n\
|
||||
# \n# /**\n# * The number of times the job may be attempted.\n# *\n# * @var int\n\
|
||||
# */\n# public $tries;\n# \n# /**\n# * The number of seconds the job can run before\
|
||||
\ timing out.\n# *\n# * @var int\n# */\n# public $timeout;\n# \n# /**\n# * The\
|
||||
\ number of seconds to wait before retrying the job when encountering an uncaught\
|
||||
\ exception.\n# *\n# * @var int\n# */\n# public $backoff;\n# \n# /**\n# * The\
|
||||
\ maximum number of unhandled exceptions to allow before failing.\n# *\n# * @var\
|
||||
\ int\n# */\n# public $maxExceptions;\n# \n# /**\n# * Create a new job handler\
|
||||
\ instance.\n# *\n# * @param mixed $event\n# * @return void"
|
||||
- name: handle
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: manager
|
||||
comment: '# * Handle the queued job.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Broadcasting\Factory $manager
|
||||
|
||||
# * @return void'
|
||||
- name: getPayloadFromEvent
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: event
|
||||
comment: '# * Get the payload for the given event.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $event
|
||||
|
||||
# * @return array'
|
||||
- name: formatProperty
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: value
|
||||
comment: '# * Format the given value for a property.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @return mixed'
|
||||
- name: displayName
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the display name for the queued job.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: __clone
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Prepare the instance for cloning.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Illuminate\Bus\Queueable
|
||||
- Illuminate\Contracts\Queue\ShouldQueue
|
||||
- Illuminate\Contracts\Support\Arrayable
|
||||
- Illuminate\Support\Arr
|
||||
- ReflectionClass
|
||||
- ReflectionProperty
|
||||
- Queueable
|
||||
interfaces:
|
||||
- ShouldQueue
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
name: BroadcastException
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: RuntimeException
|
||||
type: class
|
||||
source: RuntimeException
|
||||
properties: []
|
||||
methods: []
|
||||
traits:
|
||||
- RuntimeException
|
||||
interfaces: []
|
||||
|
|
@ -1,468 +0,0 @@
|
|||
name: BroadcastManager
|
||||
class_comment: '# * @mixin \Illuminate\Contracts\Broadcasting\Broadcaster'
|
||||
dependencies:
|
||||
- name: AblyRest
|
||||
type: class
|
||||
source: Ably\AblyRest
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: GuzzleClient
|
||||
type: class
|
||||
source: GuzzleHttp\Client
|
||||
- name: AblyBroadcaster
|
||||
type: class
|
||||
source: Illuminate\Broadcasting\Broadcasters\AblyBroadcaster
|
||||
- name: LogBroadcaster
|
||||
type: class
|
||||
source: Illuminate\Broadcasting\Broadcasters\LogBroadcaster
|
||||
- name: NullBroadcaster
|
||||
type: class
|
||||
source: Illuminate\Broadcasting\Broadcasters\NullBroadcaster
|
||||
- name: PusherBroadcaster
|
||||
type: class
|
||||
source: Illuminate\Broadcasting\Broadcasters\PusherBroadcaster
|
||||
- name: RedisBroadcaster
|
||||
type: class
|
||||
source: Illuminate\Broadcasting\Broadcasters\RedisBroadcaster
|
||||
- name: UniqueLock
|
||||
type: class
|
||||
source: Illuminate\Bus\UniqueLock
|
||||
- name: FactoryContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Broadcasting\Factory
|
||||
- name: ShouldBeUnique
|
||||
type: class
|
||||
source: Illuminate\Contracts\Broadcasting\ShouldBeUnique
|
||||
- name: ShouldBroadcastNow
|
||||
type: class
|
||||
source: Illuminate\Contracts\Broadcasting\ShouldBroadcastNow
|
||||
- name: BusDispatcherContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Bus\Dispatcher
|
||||
- name: Cache
|
||||
type: class
|
||||
source: Illuminate\Contracts\Cache\Repository
|
||||
- name: CachesRoutes
|
||||
type: class
|
||||
source: Illuminate\Contracts\Foundation\CachesRoutes
|
||||
- name: InvalidArgumentException
|
||||
type: class
|
||||
source: InvalidArgumentException
|
||||
- name: LoggerInterface
|
||||
type: class
|
||||
source: Psr\Log\LoggerInterface
|
||||
- name: Pusher
|
||||
type: class
|
||||
source: Pusher\Pusher
|
||||
properties:
|
||||
- name: app
|
||||
visibility: protected
|
||||
comment: '# * @mixin \Illuminate\Contracts\Broadcasting\Broadcaster
|
||||
|
||||
# */
|
||||
|
||||
# class BroadcastManager implements FactoryContract
|
||||
|
||||
# {
|
||||
|
||||
# /**
|
||||
|
||||
# * The application instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Container\Container'
|
||||
- name: drivers
|
||||
visibility: protected
|
||||
comment: '# * The array of resolved broadcast drivers.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: customCreators
|
||||
visibility: protected
|
||||
comment: '# * The registered custom driver creators.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: app
|
||||
comment: "# * @mixin \\Illuminate\\Contracts\\Broadcasting\\Broadcaster\n# */\n\
|
||||
# class BroadcastManager implements FactoryContract\n# {\n# /**\n# * The application\
|
||||
\ instance.\n# *\n# * @var \\Illuminate\\Contracts\\Container\\Container\n# */\n\
|
||||
# protected $app;\n# \n# /**\n# * The array of resolved broadcast drivers.\n#\
|
||||
\ *\n# * @var array\n# */\n# protected $drivers = [];\n# \n# /**\n# * The registered\
|
||||
\ custom driver creators.\n# *\n# * @var array\n# */\n# protected $customCreators\
|
||||
\ = [];\n# \n# /**\n# * Create a new manager instance.\n# *\n# * @param \\Illuminate\\\
|
||||
Contracts\\Container\\Container $app\n# * @return void"
|
||||
- name: routes
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: attributes
|
||||
default: 'null'
|
||||
comment: '# * Register the routes for handling broadcast channel authentication
|
||||
and sockets.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array|null $attributes
|
||||
|
||||
# * @return void'
|
||||
- name: userRoutes
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: attributes
|
||||
default: 'null'
|
||||
comment: '# * Register the routes for handling broadcast user authentication.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array|null $attributes
|
||||
|
||||
# * @return void'
|
||||
- name: channelRoutes
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: attributes
|
||||
default: 'null'
|
||||
comment: '# * Register the routes for handling broadcast authentication and sockets.
|
||||
|
||||
# *
|
||||
|
||||
# * Alias of "routes" method.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array|null $attributes
|
||||
|
||||
# * @return void'
|
||||
- name: socket
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
default: 'null'
|
||||
comment: '# * Get the socket ID for the given request.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request|null $request
|
||||
|
||||
# * @return string|null'
|
||||
- name: 'on'
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channels
|
||||
comment: '# * Begin sending an anonymous broadcast to the given channels.'
|
||||
- name: private
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channel
|
||||
comment: '# * Begin sending an anonymous broadcast to the given private channels.'
|
||||
- name: presence
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channel
|
||||
comment: '# * Begin sending an anonymous broadcast to the given presence channels.'
|
||||
- name: event
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: event
|
||||
default: 'null'
|
||||
comment: '# * Begin broadcasting an event.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed|null $event
|
||||
|
||||
# * @return \Illuminate\Broadcasting\PendingBroadcast'
|
||||
- name: queue
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: event
|
||||
comment: '# * Queue the given event for broadcast.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $event
|
||||
|
||||
# * @return void'
|
||||
- name: mustBeUniqueAndCannotAcquireLock
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: event
|
||||
comment: '# * Determine if the broadcastable event must be unique and determine
|
||||
if we can acquire the necessary lock.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $event
|
||||
|
||||
# * @return bool'
|
||||
- name: connection
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: driver
|
||||
default: 'null'
|
||||
comment: '# * Get a driver instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $driver
|
||||
|
||||
# * @return mixed'
|
||||
- name: driver
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
default: 'null'
|
||||
comment: '# * Get a driver instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $name
|
||||
|
||||
# * @return mixed'
|
||||
- name: get
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Attempt to get the connection from the local cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @return \Illuminate\Contracts\Broadcasting\Broadcaster'
|
||||
- name: resolve
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Resolve the given broadcaster.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @return \Illuminate\Contracts\Broadcasting\Broadcaster
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \InvalidArgumentException'
|
||||
- name: callCustomCreator
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: config
|
||||
comment: '# * Call a custom driver creator.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return mixed'
|
||||
- name: createReverbDriver
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: config
|
||||
comment: '# * Create an instance of the driver.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return \Illuminate\Contracts\Broadcasting\Broadcaster'
|
||||
- name: createPusherDriver
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: config
|
||||
comment: '# * Create an instance of the driver.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return \Illuminate\Contracts\Broadcasting\Broadcaster'
|
||||
- name: pusher
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: config
|
||||
comment: '# * Get a Pusher instance for the given configuration.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return \Pusher\Pusher'
|
||||
- name: createAblyDriver
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: config
|
||||
comment: '# * Create an instance of the driver.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return \Illuminate\Contracts\Broadcasting\Broadcaster'
|
||||
- name: ably
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: config
|
||||
comment: '# * Get an Ably instance for the given configuration.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return \Ably\AblyRest'
|
||||
- name: createRedisDriver
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: config
|
||||
comment: '# * Create an instance of the driver.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return \Illuminate\Contracts\Broadcasting\Broadcaster'
|
||||
- name: createLogDriver
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: config
|
||||
comment: '# * Create an instance of the driver.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return \Illuminate\Contracts\Broadcasting\Broadcaster'
|
||||
- name: createNullDriver
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: config
|
||||
comment: '# * Create an instance of the driver.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $config
|
||||
|
||||
# * @return \Illuminate\Contracts\Broadcasting\Broadcaster'
|
||||
- name: getConfig
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Get the connection configuration.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @return array'
|
||||
- name: getDefaultDriver
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the default driver name.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: setDefaultDriver
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Set the default driver name.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @return void'
|
||||
- name: purge
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
default: 'null'
|
||||
comment: '# * Disconnect the given disk and remove from local cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $name
|
||||
|
||||
# * @return void'
|
||||
- name: extend
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: driver
|
||||
- name: callback
|
||||
comment: '# * Register a custom driver creator Closure.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $driver
|
||||
|
||||
# * @param \Closure $callback
|
||||
|
||||
# * @return $this'
|
||||
- name: getApplication
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the application instance used by the manager.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Contracts\Foundation\Application'
|
||||
- name: setApplication
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: app
|
||||
comment: '# * Set the application instance used by the manager.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Foundation\Application $app
|
||||
|
||||
# * @return $this'
|
||||
- name: forgetDrivers
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Forget all of the resolved driver instances.
|
||||
|
||||
# *
|
||||
|
||||
# * @return $this'
|
||||
- name: __call
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: method
|
||||
- name: parameters
|
||||
comment: '# * Dynamically call the default driver instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $method
|
||||
|
||||
# * @param array $parameters
|
||||
|
||||
# * @return mixed'
|
||||
traits:
|
||||
- Ably\AblyRest
|
||||
- Closure
|
||||
- Illuminate\Broadcasting\Broadcasters\AblyBroadcaster
|
||||
- Illuminate\Broadcasting\Broadcasters\LogBroadcaster
|
||||
- Illuminate\Broadcasting\Broadcasters\NullBroadcaster
|
||||
- Illuminate\Broadcasting\Broadcasters\PusherBroadcaster
|
||||
- Illuminate\Broadcasting\Broadcasters\RedisBroadcaster
|
||||
- Illuminate\Bus\UniqueLock
|
||||
- Illuminate\Contracts\Broadcasting\ShouldBeUnique
|
||||
- Illuminate\Contracts\Broadcasting\ShouldBroadcastNow
|
||||
- Illuminate\Contracts\Foundation\CachesRoutes
|
||||
- InvalidArgumentException
|
||||
- Psr\Log\LoggerInterface
|
||||
- Pusher\Pusher
|
||||
interfaces:
|
||||
- FactoryContract
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
name: BroadcastServiceProvider
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: BroadcasterContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Broadcasting\Broadcaster
|
||||
- name: BroadcastingFactory
|
||||
type: class
|
||||
source: Illuminate\Contracts\Broadcasting\Factory
|
||||
- name: DeferrableProvider
|
||||
type: class
|
||||
source: Illuminate\Contracts\Support\DeferrableProvider
|
||||
- name: ServiceProvider
|
||||
type: class
|
||||
source: Illuminate\Support\ServiceProvider
|
||||
properties: []
|
||||
methods:
|
||||
- name: register
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Register the service provider.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: provides
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the services provided by the provider.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
traits:
|
||||
- Illuminate\Contracts\Support\DeferrableProvider
|
||||
- Illuminate\Support\ServiceProvider
|
||||
interfaces:
|
||||
- DeferrableProvider
|
||||
|
|
@ -1,212 +0,0 @@
|
|||
name: AblyBroadcaster
|
||||
class_comment: '# * @author Matthew Hall (matthall28@gmail.com)
|
||||
|
||||
# * @author Taylor Otwell (taylor@laravel.com)'
|
||||
dependencies:
|
||||
- name: AblyRest
|
||||
type: class
|
||||
source: Ably\AblyRest
|
||||
- name: AblyException
|
||||
type: class
|
||||
source: Ably\Exceptions\AblyException
|
||||
- name: AblyMessage
|
||||
type: class
|
||||
source: Ably\Models\Message
|
||||
- name: BroadcastException
|
||||
type: class
|
||||
source: Illuminate\Broadcasting\BroadcastException
|
||||
- name: Str
|
||||
type: class
|
||||
source: Illuminate\Support\Str
|
||||
- name: AccessDeniedHttpException
|
||||
type: class
|
||||
source: Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
|
||||
properties:
|
||||
- name: ably
|
||||
visibility: protected
|
||||
comment: '# * @author Matthew Hall (matthall28@gmail.com)
|
||||
|
||||
# * @author Taylor Otwell (taylor@laravel.com)
|
||||
|
||||
# */
|
||||
|
||||
# class AblyBroadcaster extends Broadcaster
|
||||
|
||||
# {
|
||||
|
||||
# /**
|
||||
|
||||
# * The AblyRest SDK instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Ably\AblyRest'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: ably
|
||||
comment: "# * @author Matthew Hall (matthall28@gmail.com)\n# * @author Taylor Otwell\
|
||||
\ (taylor@laravel.com)\n# */\n# class AblyBroadcaster extends Broadcaster\n# {\n\
|
||||
# /**\n# * The AblyRest SDK instance.\n# *\n# * @var \\Ably\\AblyRest\n# */\n\
|
||||
# protected $ably;\n# \n# /**\n# * Create a new broadcaster instance.\n# *\n#\
|
||||
\ * @param \\Ably\\AblyRest $ably\n# * @return void"
|
||||
- name: auth
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
comment: '# * Authenticate the incoming request for a given channel.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @return mixed
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException'
|
||||
- name: validAuthenticationResponse
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
- name: result
|
||||
comment: '# * Return the valid authentication response.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param mixed $result
|
||||
|
||||
# * @return mixed'
|
||||
- name: generateAblySignature
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channelName
|
||||
- name: socketId
|
||||
- name: userData
|
||||
default: 'null'
|
||||
comment: '# * Generate the signature needed for Ably authentication headers.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $channelName
|
||||
|
||||
# * @param string $socketId
|
||||
|
||||
# * @param array|null $userData
|
||||
|
||||
# * @return string'
|
||||
- name: broadcast
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channels
|
||||
- name: event
|
||||
- name: payload
|
||||
default: '[]'
|
||||
comment: '# * Broadcast the given event.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $channels
|
||||
|
||||
# * @param string $event
|
||||
|
||||
# * @param array $payload
|
||||
|
||||
# * @return void
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Broadcasting\BroadcastException'
|
||||
- name: buildAblyMessage
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: event
|
||||
- name: payload
|
||||
default: '[]'
|
||||
comment: '# * Build an Ably message object for broadcasting.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $event
|
||||
|
||||
# * @param array $payload
|
||||
|
||||
# * @return \Ably\Models\Message'
|
||||
- name: isGuardedChannel
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channel
|
||||
comment: '# * Return true if the channel is protected by authentication.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $channel
|
||||
|
||||
# * @return bool'
|
||||
- name: normalizeChannelName
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channel
|
||||
comment: '# * Remove prefix from channel name.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $channel
|
||||
|
||||
# * @return string'
|
||||
- name: formatChannels
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: channels
|
||||
comment: '# * Format the channel array into an array of strings.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $channels
|
||||
|
||||
# * @return array'
|
||||
- name: getPublicToken
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Get the public token value from the Ably key.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: getPrivateToken
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Get the private token value from the Ably key.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: getAbly
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the underlying Ably SDK instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Ably\AblyRest'
|
||||
- name: setAbly
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: ably
|
||||
comment: '# * Set the underlying Ably SDK instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Ably\AblyRest $ably
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Ably\AblyRest
|
||||
- Ably\Exceptions\AblyException
|
||||
- Illuminate\Broadcasting\BroadcastException
|
||||
- Illuminate\Support\Str
|
||||
- Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
|
||||
interfaces: []
|
||||
|
|
@ -1,354 +0,0 @@
|
|||
name: Broadcaster
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: Exception
|
||||
type: class
|
||||
source: Exception
|
||||
- name: Container
|
||||
type: class
|
||||
source: Illuminate\Container\Container
|
||||
- name: BroadcasterContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Broadcasting\Broadcaster
|
||||
- name: HasBroadcastChannel
|
||||
type: class
|
||||
source: Illuminate\Contracts\Broadcasting\HasBroadcastChannel
|
||||
- name: BindingRegistrar
|
||||
type: class
|
||||
source: Illuminate\Contracts\Routing\BindingRegistrar
|
||||
- name: UrlRoutable
|
||||
type: class
|
||||
source: Illuminate\Contracts\Routing\UrlRoutable
|
||||
- name: Arr
|
||||
type: class
|
||||
source: Illuminate\Support\Arr
|
||||
- name: Reflector
|
||||
type: class
|
||||
source: Illuminate\Support\Reflector
|
||||
- name: ReflectionClass
|
||||
type: class
|
||||
source: ReflectionClass
|
||||
- name: ReflectionFunction
|
||||
type: class
|
||||
source: ReflectionFunction
|
||||
- name: AccessDeniedHttpException
|
||||
type: class
|
||||
source: Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
|
||||
properties:
|
||||
- name: authenticatedUserCallback
|
||||
visibility: protected
|
||||
comment: '# * The callback to resolve the authenticated user information.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Closure|null'
|
||||
- name: channels
|
||||
visibility: protected
|
||||
comment: '# * The registered channel authenticators.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: channelOptions
|
||||
visibility: protected
|
||||
comment: '# * The registered channel options.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: bindingRegistrar
|
||||
visibility: protected
|
||||
comment: '# * The binding registrar instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Routing\BindingRegistrar'
|
||||
methods:
|
||||
- name: resolveAuthenticatedUser
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
comment: "# * The callback to resolve the authenticated user information.\n# *\n\
|
||||
# * @var \\Closure|null\n# */\n# protected $authenticatedUserCallback = null;\n\
|
||||
# \n# /**\n# * The registered channel authenticators.\n# *\n# * @var array\n#\
|
||||
\ */\n# protected $channels = [];\n# \n# /**\n# * The registered channel options.\n\
|
||||
# *\n# * @var array\n# */\n# protected $channelOptions = [];\n# \n# /**\n# * The\
|
||||
\ binding registrar instance.\n# *\n# * @var \\Illuminate\\Contracts\\Routing\\\
|
||||
BindingRegistrar\n# */\n# protected $bindingRegistrar;\n# \n# /**\n# * Resolve\
|
||||
\ the authenticated user payload for the incoming connection request.\n# *\n#\
|
||||
\ * See: https://pusher.com/docs/channels/library_auth_reference/auth-signatures/#user-authentication.\n\
|
||||
# *\n# * @param \\Illuminate\\Http\\Request $request\n# * @return array|null"
|
||||
- name: resolveAuthenticatedUserUsing
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Register the user retrieval callback used to authenticate connections.
|
||||
|
||||
# *
|
||||
|
||||
# * See: https://pusher.com/docs/channels/library_auth_reference/auth-signatures/#user-authentication.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Closure $callback
|
||||
|
||||
# * @return void'
|
||||
- name: channel
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channel
|
||||
- name: callback
|
||||
- name: options
|
||||
default: '[]'
|
||||
comment: '# * Register a channel authenticator.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Broadcasting\HasBroadcastChannel|string $channel
|
||||
|
||||
# * @param callable|string $callback
|
||||
|
||||
# * @param array $options
|
||||
|
||||
# * @return $this'
|
||||
- name: verifyUserCanAccessChannel
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: request
|
||||
- name: channel
|
||||
comment: '# * Authenticate the incoming request for a given channel.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param string $channel
|
||||
|
||||
# * @return mixed
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException'
|
||||
- name: extractAuthParameters
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: pattern
|
||||
- name: channel
|
||||
- name: callback
|
||||
comment: '# * Extract the parameters from the given pattern and channel.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $pattern
|
||||
|
||||
# * @param string $channel
|
||||
|
||||
# * @param callable|string $callback
|
||||
|
||||
# * @return array'
|
||||
- name: extractParameters
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Extracts the parameters out of what the user passed to handle the
|
||||
channel authentication.
|
||||
|
||||
# *
|
||||
|
||||
# * @param callable|string $callback
|
||||
|
||||
# * @return \ReflectionParameter[]
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Exception'
|
||||
- name: extractParametersFromClass
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Extracts the parameters out of a class channel''s "join" method.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $callback
|
||||
|
||||
# * @return \ReflectionParameter[]
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Exception'
|
||||
- name: extractChannelKeys
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: pattern
|
||||
- name: channel
|
||||
comment: '# * Extract the channel keys from the incoming channel name.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $pattern
|
||||
|
||||
# * @param string $channel
|
||||
|
||||
# * @return array'
|
||||
- name: resolveBinding
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
- name: callbackParameters
|
||||
comment: '# * Resolve the given parameter binding.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param string $value
|
||||
|
||||
# * @param array $callbackParameters
|
||||
|
||||
# * @return mixed'
|
||||
- name: resolveExplicitBindingIfPossible
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
comment: '# * Resolve an explicit parameter binding if applicable.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @return mixed'
|
||||
- name: resolveImplicitBindingIfPossible
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
- name: callbackParameters
|
||||
comment: '# * Resolve an implicit parameter binding if applicable.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @param array $callbackParameters
|
||||
|
||||
# * @return mixed
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException'
|
||||
- name: isImplicitlyBindable
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: key
|
||||
- name: parameter
|
||||
comment: '# * Determine if a given key and parameter is implicitly bindable.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param \ReflectionParameter $parameter
|
||||
|
||||
# * @return bool'
|
||||
- name: formatChannels
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: channels
|
||||
comment: '# * Format the channel array into an array of strings.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $channels
|
||||
|
||||
# * @return array'
|
||||
- name: binder
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Get the model binding registrar instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Contracts\Routing\BindingRegistrar'
|
||||
- name: normalizeChannelHandlerToCallable
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Normalize the given callback into a callable.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $callback
|
||||
|
||||
# * @return callable'
|
||||
- name: retrieveUser
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: request
|
||||
- name: channel
|
||||
comment: '# * Retrieve the authenticated user using the configured guard (if any).
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param string $channel
|
||||
|
||||
# * @return mixed'
|
||||
- name: retrieveChannelOptions
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: channel
|
||||
comment: '# * Retrieve options for a certain channel.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $channel
|
||||
|
||||
# * @return array'
|
||||
- name: channelNameMatchesPattern
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: channel
|
||||
- name: pattern
|
||||
comment: '# * Check if the channel name from the request matches a pattern from
|
||||
registered channels.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $channel
|
||||
|
||||
# * @param string $pattern
|
||||
|
||||
# * @return bool'
|
||||
- name: getChannels
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get all of the registered channels.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Support\Collection'
|
||||
traits:
|
||||
- Closure
|
||||
- Exception
|
||||
- Illuminate\Container\Container
|
||||
- Illuminate\Contracts\Broadcasting\HasBroadcastChannel
|
||||
- Illuminate\Contracts\Routing\BindingRegistrar
|
||||
- Illuminate\Contracts\Routing\UrlRoutable
|
||||
- Illuminate\Support\Arr
|
||||
- Illuminate\Support\Reflector
|
||||
- ReflectionClass
|
||||
- ReflectionFunction
|
||||
- Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
|
||||
interfaces:
|
||||
- BroadcasterContract
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
name: LogBroadcaster
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: LoggerInterface
|
||||
type: class
|
||||
source: Psr\Log\LoggerInterface
|
||||
properties:
|
||||
- name: logger
|
||||
visibility: protected
|
||||
comment: '# * The logger implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Psr\Log\LoggerInterface'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: logger
|
||||
comment: "# * The logger implementation.\n# *\n# * @var \\Psr\\Log\\LoggerInterface\n\
|
||||
# */\n# protected $logger;\n# \n# /**\n# * Create a new broadcaster instance.\n\
|
||||
# *\n# * @param \\Psr\\Log\\LoggerInterface $logger\n# * @return void"
|
||||
- name: auth
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
comment: '# * {@inheritdoc}'
|
||||
- name: validAuthenticationResponse
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
- name: result
|
||||
comment: '# * {@inheritdoc}'
|
||||
- name: broadcast
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channels
|
||||
- name: event
|
||||
- name: payload
|
||||
default: '[]'
|
||||
comment: '# * {@inheritdoc}'
|
||||
traits:
|
||||
- Psr\Log\LoggerInterface
|
||||
interfaces: []
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
name: NullBroadcaster
|
||||
class_comment: null
|
||||
dependencies: []
|
||||
properties: []
|
||||
methods:
|
||||
- name: auth
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
comment: '# * {@inheritdoc}'
|
||||
- name: validAuthenticationResponse
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
- name: result
|
||||
comment: '# * {@inheritdoc}'
|
||||
- name: broadcast
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channels
|
||||
- name: event
|
||||
- name: payload
|
||||
default: '[]'
|
||||
comment: '# * {@inheritdoc}'
|
||||
traits: []
|
||||
interfaces: []
|
||||
|
|
@ -1,151 +0,0 @@
|
|||
name: PusherBroadcaster
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: BroadcastException
|
||||
type: class
|
||||
source: Illuminate\Broadcasting\BroadcastException
|
||||
- name: Arr
|
||||
type: class
|
||||
source: Illuminate\Support\Arr
|
||||
- name: Collection
|
||||
type: class
|
||||
source: Illuminate\Support\Collection
|
||||
- name: ApiErrorException
|
||||
type: class
|
||||
source: Pusher\ApiErrorException
|
||||
- name: Pusher
|
||||
type: class
|
||||
source: Pusher\Pusher
|
||||
- name: AccessDeniedHttpException
|
||||
type: class
|
||||
source: Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
|
||||
- name: UsePusherChannelConventions
|
||||
type: class
|
||||
source: UsePusherChannelConventions
|
||||
properties:
|
||||
- name: pusher
|
||||
visibility: protected
|
||||
comment: '# * The Pusher SDK instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Pusher\Pusher'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: pusher
|
||||
comment: "# * The Pusher SDK instance.\n# *\n# * @var \\Pusher\\Pusher\n# */\n#\
|
||||
\ protected $pusher;\n# \n# /**\n# * Create a new broadcaster instance.\n# *\n\
|
||||
# * @param \\Pusher\\Pusher $pusher\n# * @return void"
|
||||
- name: resolveAuthenticatedUser
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
comment: '# * Resolve the authenticated user payload for an incoming connection
|
||||
request.
|
||||
|
||||
# *
|
||||
|
||||
# * See: https://pusher.com/docs/channels/library_auth_reference/auth-signatures/#user-authentication
|
||||
|
||||
# * See: https://pusher.com/docs/channels/server_api/authenticating-users/#response
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @return array|null'
|
||||
- name: auth
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
comment: '# * Authenticate the incoming request for a given channel.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @return mixed
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException'
|
||||
- name: validAuthenticationResponse
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
- name: result
|
||||
comment: '# * Return the valid authentication response.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param mixed $result
|
||||
|
||||
# * @return mixed'
|
||||
- name: decodePusherResponse
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: request
|
||||
- name: response
|
||||
comment: '# * Decode the given Pusher response.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param mixed $response
|
||||
|
||||
# * @return array'
|
||||
- name: broadcast
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channels
|
||||
- name: event
|
||||
- name: payload
|
||||
default: '[]'
|
||||
comment: '# * Broadcast the given event.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $channels
|
||||
|
||||
# * @param string $event
|
||||
|
||||
# * @param array $payload
|
||||
|
||||
# * @return void
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Broadcasting\BroadcastException'
|
||||
- name: getPusher
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the Pusher SDK instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Pusher\Pusher'
|
||||
- name: setPusher
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: pusher
|
||||
comment: '# * Set the Pusher SDK instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Pusher\Pusher $pusher
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Illuminate\Broadcasting\BroadcastException
|
||||
- Illuminate\Support\Arr
|
||||
- Illuminate\Support\Collection
|
||||
- Pusher\ApiErrorException
|
||||
- Pusher\Pusher
|
||||
- Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
|
||||
- UsePusherChannelConventions
|
||||
interfaces: []
|
||||
|
|
@ -1,146 +0,0 @@
|
|||
name: RedisBroadcaster
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: BroadcastException
|
||||
type: class
|
||||
source: Illuminate\Broadcasting\BroadcastException
|
||||
- name: Redis
|
||||
type: class
|
||||
source: Illuminate\Contracts\Redis\Factory
|
||||
- name: Arr
|
||||
type: class
|
||||
source: Illuminate\Support\Arr
|
||||
- name: ConnectionException
|
||||
type: class
|
||||
source: Predis\Connection\ConnectionException
|
||||
- name: RedisException
|
||||
type: class
|
||||
source: RedisException
|
||||
- name: AccessDeniedHttpException
|
||||
type: class
|
||||
source: Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
|
||||
- name: UsePusherChannelConventions
|
||||
type: class
|
||||
source: UsePusherChannelConventions
|
||||
properties:
|
||||
- name: redis
|
||||
visibility: protected
|
||||
comment: '# * The Redis instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Redis\Factory'
|
||||
- name: connection
|
||||
visibility: protected
|
||||
comment: '# * The Redis connection to use for broadcasting.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string|null'
|
||||
- name: prefix
|
||||
visibility: protected
|
||||
comment: '# * The Redis key prefix.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: redis
|
||||
- name: connection
|
||||
default: 'null'
|
||||
- name: prefix
|
||||
default: ''''''
|
||||
comment: "# * The Redis instance.\n# *\n# * @var \\Illuminate\\Contracts\\Redis\\\
|
||||
Factory\n# */\n# protected $redis;\n# \n# /**\n# * The Redis connection to use\
|
||||
\ for broadcasting.\n# *\n# * @var string|null\n# */\n# protected $connection\
|
||||
\ = null;\n# \n# /**\n# * The Redis key prefix.\n# *\n# * @var string\n# */\n\
|
||||
# protected $prefix = '';\n# \n# /**\n# * Create a new broadcaster instance.\n\
|
||||
# *\n# * @param \\Illuminate\\Contracts\\Redis\\Factory $redis\n# * @param \
|
||||
\ string|null $connection\n# * @param string $prefix\n# * @return void"
|
||||
- name: auth
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
comment: '# * Authenticate the incoming request for a given channel.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @return mixed
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException'
|
||||
- name: validAuthenticationResponse
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: request
|
||||
- name: result
|
||||
comment: '# * Return the valid authentication response.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Http\Request $request
|
||||
|
||||
# * @param mixed $result
|
||||
|
||||
# * @return mixed'
|
||||
- name: broadcast
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channels
|
||||
- name: event
|
||||
- name: payload
|
||||
default: '[]'
|
||||
comment: '# * Broadcast the given event.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $channels
|
||||
|
||||
# * @param string $event
|
||||
|
||||
# * @param array $payload
|
||||
|
||||
# * @return void
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Illuminate\Broadcasting\BroadcastException'
|
||||
- name: broadcastMultipleChannelsScript
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Get the Lua script for broadcasting to multiple channels.
|
||||
|
||||
# *
|
||||
|
||||
# * ARGV[1] - The payload
|
||||
|
||||
# * ARGV[2...] - The channels
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: formatChannels
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: channels
|
||||
comment: '# * Format the channel array into an array of strings.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $channels
|
||||
|
||||
# * @return array'
|
||||
traits:
|
||||
- Illuminate\Broadcasting\BroadcastException
|
||||
- Illuminate\Support\Arr
|
||||
- Predis\Connection\ConnectionException
|
||||
- RedisException
|
||||
- Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
|
||||
- UsePusherChannelConventions
|
||||
interfaces: []
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
name: UsePusherChannelConventions
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Str
|
||||
type: class
|
||||
source: Illuminate\Support\Str
|
||||
properties: []
|
||||
methods:
|
||||
- name: isGuardedChannel
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channel
|
||||
comment: '# * Return true if the channel is protected by authentication.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $channel
|
||||
|
||||
# * @return bool'
|
||||
- name: normalizeChannelName
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: channel
|
||||
comment: '# * Remove prefix from channel name.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $channel
|
||||
|
||||
# * @return string'
|
||||
traits:
|
||||
- Illuminate\Support\Str
|
||||
interfaces: []
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
name: Channel
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: HasBroadcastChannel
|
||||
type: class
|
||||
source: Illuminate\Contracts\Broadcasting\HasBroadcastChannel
|
||||
- name: Stringable
|
||||
type: class
|
||||
source: Stringable
|
||||
properties:
|
||||
- name: name
|
||||
visibility: public
|
||||
comment: '# * The channel''s name.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
comment: "# * The channel's name.\n# *\n# * @var string\n# */\n# public $name;\n\
|
||||
# \n# /**\n# * Create a new channel instance.\n# *\n# * @param \\Illuminate\\\
|
||||
Contracts\\Broadcasting\\HasBroadcastChannel|string $name\n# * @return void"
|
||||
- name: __toString
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Convert the channel instance to a string.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
traits:
|
||||
- Illuminate\Contracts\Broadcasting\HasBroadcastChannel
|
||||
- Stringable
|
||||
interfaces:
|
||||
- Stringable
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
name: EncryptedPrivateChannel
|
||||
class_comment: null
|
||||
dependencies: []
|
||||
properties: []
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Create a new channel instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @return void'
|
||||
traits: []
|
||||
interfaces: []
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
name: InteractsWithBroadcasting
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Arr
|
||||
type: class
|
||||
source: Illuminate\Support\Arr
|
||||
properties:
|
||||
- name: broadcastConnection
|
||||
visibility: protected
|
||||
comment: '# * The broadcaster connection to use to broadcast the event.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
methods:
|
||||
- name: broadcastVia
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: connection
|
||||
default: 'null'
|
||||
comment: "# * The broadcaster connection to use to broadcast the event.\n# *\n#\
|
||||
\ * @var array\n# */\n# protected $broadcastConnection = [null];\n# \n# /**\n\
|
||||
# * Broadcast the event using a specific broadcaster.\n# *\n# * @param array|string|null\
|
||||
\ $connection\n# * @return $this"
|
||||
- name: broadcastConnections
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the broadcaster connections the event should be broadcast on.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
traits:
|
||||
- Illuminate\Support\Arr
|
||||
interfaces: []
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
name: InteractsWithSockets
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Broadcast
|
||||
type: class
|
||||
source: Illuminate\Support\Facades\Broadcast
|
||||
properties:
|
||||
- name: socket
|
||||
visibility: public
|
||||
comment: '# * The socket ID for the user that raised the event.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string|null'
|
||||
methods:
|
||||
- name: dontBroadcastToCurrentUser
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: "# * The socket ID for the user that raised the event.\n# *\n# * @var string|null\n\
|
||||
# */\n# public $socket;\n# \n# /**\n# * Exclude the current user from receiving\
|
||||
\ the broadcast.\n# *\n# * @return $this"
|
||||
- name: broadcastToEveryone
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Broadcast the event to everyone.
|
||||
|
||||
# *
|
||||
|
||||
# * @return $this'
|
||||
traits:
|
||||
- Illuminate\Support\Facades\Broadcast
|
||||
interfaces: []
|
||||
|
|
@ -1,64 +0,0 @@
|
|||
name: PendingBroadcast
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Dispatcher
|
||||
type: class
|
||||
source: Illuminate\Contracts\Events\Dispatcher
|
||||
properties:
|
||||
- name: events
|
||||
visibility: protected
|
||||
comment: '# * The event dispatcher implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Events\Dispatcher'
|
||||
- name: event
|
||||
visibility: protected
|
||||
comment: '# * The event instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var mixed'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: events
|
||||
- name: event
|
||||
comment: "# * The event dispatcher implementation.\n# *\n# * @var \\Illuminate\\\
|
||||
Contracts\\Events\\Dispatcher\n# */\n# protected $events;\n# \n# /**\n# * The\
|
||||
\ event instance.\n# *\n# * @var mixed\n# */\n# protected $event;\n# \n# /**\n\
|
||||
# * Create a new pending broadcast instance.\n# *\n# * @param \\Illuminate\\\
|
||||
Contracts\\Events\\Dispatcher $events\n# * @param mixed $event\n# * @return\
|
||||
\ void"
|
||||
- name: via
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: connection
|
||||
default: 'null'
|
||||
comment: '# * Broadcast the event using a specific broadcaster.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $connection
|
||||
|
||||
# * @return $this'
|
||||
- name: toOthers
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Broadcast the event to everyone except the current user.
|
||||
|
||||
# *
|
||||
|
||||
# * @return $this'
|
||||
- name: __destruct
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Handle the object''s destruction.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Illuminate\Contracts\Events\Dispatcher
|
||||
interfaces: []
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
name: PresenceChannel
|
||||
class_comment: null
|
||||
dependencies: []
|
||||
properties: []
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Create a new channel instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @return void'
|
||||
traits: []
|
||||
interfaces: []
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
name: PrivateChannel
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: HasBroadcastChannel
|
||||
type: class
|
||||
source: Illuminate\Contracts\Broadcasting\HasBroadcastChannel
|
||||
properties: []
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Create a new channel instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Broadcasting\HasBroadcastChannel|string $name
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Illuminate\Contracts\Broadcasting\HasBroadcastChannel
|
||||
interfaces: []
|
||||
|
|
@ -1,50 +0,0 @@
|
|||
name: UniqueBroadcastEvent
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Container
|
||||
type: class
|
||||
source: Illuminate\Container\Container
|
||||
- name: Repository
|
||||
type: class
|
||||
source: Illuminate\Contracts\Cache\Repository
|
||||
- name: ShouldBeUnique
|
||||
type: class
|
||||
source: Illuminate\Contracts\Queue\ShouldBeUnique
|
||||
properties:
|
||||
- name: uniqueId
|
||||
visibility: public
|
||||
comment: '# * The unique lock identifier.
|
||||
|
||||
# *
|
||||
|
||||
# * @var mixed'
|
||||
- name: uniqueFor
|
||||
visibility: public
|
||||
comment: '# * The number of seconds the unique lock should be maintained.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: event
|
||||
comment: "# * The unique lock identifier.\n# *\n# * @var mixed\n# */\n# public $uniqueId;\n\
|
||||
# \n# /**\n# * The number of seconds the unique lock should be maintained.\n#\
|
||||
\ *\n# * @var int\n# */\n# public $uniqueFor;\n# \n# /**\n# * Create a new event\
|
||||
\ instance.\n# *\n# * @param mixed $event\n# * @return void"
|
||||
- name: uniqueVia
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Resolve the cache implementation that should manage the event''s uniqueness.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Contracts\Cache\Repository'
|
||||
traits:
|
||||
- Illuminate\Container\Container
|
||||
- Illuminate\Contracts\Cache\Repository
|
||||
- Illuminate\Contracts\Queue\ShouldBeUnique
|
||||
interfaces:
|
||||
- ShouldBeUnique
|
||||
|
|
@ -1,398 +0,0 @@
|
|||
name: Batch
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: CarbonImmutable
|
||||
type: class
|
||||
source: Carbon\CarbonImmutable
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: QueueFactory
|
||||
type: class
|
||||
source: Illuminate\Contracts\Queue\Factory
|
||||
- name: Arrayable
|
||||
type: class
|
||||
source: Illuminate\Contracts\Support\Arrayable
|
||||
- name: CallQueuedClosure
|
||||
type: class
|
||||
source: Illuminate\Queue\CallQueuedClosure
|
||||
- name: Arr
|
||||
type: class
|
||||
source: Illuminate\Support\Arr
|
||||
- name: Collection
|
||||
type: class
|
||||
source: Illuminate\Support\Collection
|
||||
- name: JsonSerializable
|
||||
type: class
|
||||
source: JsonSerializable
|
||||
- name: Throwable
|
||||
type: class
|
||||
source: Throwable
|
||||
properties:
|
||||
- name: queue
|
||||
visibility: protected
|
||||
comment: '# * The queue factory implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Queue\Factory'
|
||||
- name: repository
|
||||
visibility: protected
|
||||
comment: '# * The repository implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Bus\BatchRepository'
|
||||
- name: id
|
||||
visibility: public
|
||||
comment: '# * The batch ID.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: name
|
||||
visibility: public
|
||||
comment: '# * The batch name.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: totalJobs
|
||||
visibility: public
|
||||
comment: '# * The total number of jobs that belong to the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
- name: pendingJobs
|
||||
visibility: public
|
||||
comment: '# * The total number of jobs that are still pending.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
- name: failedJobs
|
||||
visibility: public
|
||||
comment: '# * The total number of jobs that have failed.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
- name: failedJobIds
|
||||
visibility: public
|
||||
comment: '# * The IDs of the jobs that have failed.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: options
|
||||
visibility: public
|
||||
comment: '# * The batch options.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: createdAt
|
||||
visibility: public
|
||||
comment: '# * The date indicating when the batch was created.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Carbon\CarbonImmutable'
|
||||
- name: cancelledAt
|
||||
visibility: public
|
||||
comment: '# * The date indicating when the batch was cancelled.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Carbon\CarbonImmutable|null'
|
||||
- name: finishedAt
|
||||
visibility: public
|
||||
comment: '# * The date indicating when the batch was finished.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Carbon\CarbonImmutable|null'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: queue
|
||||
- name: repository
|
||||
- name: id
|
||||
- name: name
|
||||
- name: totalJobs
|
||||
- name: pendingJobs
|
||||
- name: failedJobs
|
||||
- name: failedJobIds
|
||||
- name: options
|
||||
- name: createdAt
|
||||
- name: cancelledAt
|
||||
default: 'null'
|
||||
- name: finishedAt
|
||||
default: 'null'
|
||||
comment: "# * The queue factory implementation.\n# *\n# * @var \\Illuminate\\Contracts\\\
|
||||
Queue\\Factory\n# */\n# protected $queue;\n# \n# /**\n# * The repository implementation.\n\
|
||||
# *\n# * @var \\Illuminate\\Bus\\BatchRepository\n# */\n# protected $repository;\n\
|
||||
# \n# /**\n# * The batch ID.\n# *\n# * @var string\n# */\n# public $id;\n# \n\
|
||||
# /**\n# * The batch name.\n# *\n# * @var string\n# */\n# public $name;\n# \n\
|
||||
# /**\n# * The total number of jobs that belong to the batch.\n# *\n# * @var int\n\
|
||||
# */\n# public $totalJobs;\n# \n# /**\n# * The total number of jobs that are still\
|
||||
\ pending.\n# *\n# * @var int\n# */\n# public $pendingJobs;\n# \n# /**\n# * The\
|
||||
\ total number of jobs that have failed.\n# *\n# * @var int\n# */\n# public $failedJobs;\n\
|
||||
# \n# /**\n# * The IDs of the jobs that have failed.\n# *\n# * @var array\n# */\n\
|
||||
# public $failedJobIds;\n# \n# /**\n# * The batch options.\n# *\n# * @var array\n\
|
||||
# */\n# public $options;\n# \n# /**\n# * The date indicating when the batch was\
|
||||
\ created.\n# *\n# * @var \\Carbon\\CarbonImmutable\n# */\n# public $createdAt;\n\
|
||||
# \n# /**\n# * The date indicating when the batch was cancelled.\n# *\n# * @var\
|
||||
\ \\Carbon\\CarbonImmutable|null\n# */\n# public $cancelledAt;\n# \n# /**\n# *\
|
||||
\ The date indicating when the batch was finished.\n# *\n# * @var \\Carbon\\CarbonImmutable|null\n\
|
||||
# */\n# public $finishedAt;\n# \n# /**\n# * Create a new batch instance.\n# *\n\
|
||||
# * @param \\Illuminate\\Contracts\\Queue\\Factory $queue\n# * @param \\Illuminate\\\
|
||||
Bus\\BatchRepository $repository\n# * @param string $id\n# * @param string\
|
||||
\ $name\n# * @param int $totalJobs\n# * @param int $pendingJobs\n# * @param\
|
||||
\ int $failedJobs\n# * @param array $failedJobIds\n# * @param array $options\n\
|
||||
# * @param \\Carbon\\CarbonImmutable $createdAt\n# * @param \\Carbon\\CarbonImmutable|null\
|
||||
\ $cancelledAt\n# * @param \\Carbon\\CarbonImmutable|null $finishedAt\n# *\
|
||||
\ @return void"
|
||||
- name: fresh
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get a fresh instance of the batch represented by this ID.
|
||||
|
||||
# *
|
||||
|
||||
# * @return self'
|
||||
- name: add
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: jobs
|
||||
comment: '# * Add additional jobs to the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Support\Enumerable|object|array $jobs
|
||||
|
||||
# * @return self'
|
||||
- name: prepareBatchedChain
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: chain
|
||||
comment: '# * Prepare a chain that exists within the jobs being added.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $chain
|
||||
|
||||
# * @return \Illuminate\Support\Collection'
|
||||
- name: processedJobs
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the total number of jobs that have been processed by the batch
|
||||
thus far.
|
||||
|
||||
# *
|
||||
|
||||
# * @return int'
|
||||
- name: progress
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the percentage of jobs that have been processed (between 0-100).
|
||||
|
||||
# *
|
||||
|
||||
# * @return int'
|
||||
- name: recordSuccessfulJob
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: jobId
|
||||
comment: '# * Record that a job within the batch finished successfully, executing
|
||||
any callbacks if necessary.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $jobId
|
||||
|
||||
# * @return void'
|
||||
- name: decrementPendingJobs
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: jobId
|
||||
comment: '# * Decrement the pending jobs for the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $jobId
|
||||
|
||||
# * @return \Illuminate\Bus\UpdatedBatchJobCounts'
|
||||
- name: finished
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the batch has finished executing.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: hasProgressCallbacks
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the batch has "progress" callbacks.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: hasThenCallbacks
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the batch has "success" callbacks.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: allowsFailures
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the batch allows jobs to fail without cancelling the
|
||||
batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: hasFailures
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the batch has job failures.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: recordFailedJob
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: jobId
|
||||
- name: e
|
||||
comment: '# * Record that a job within the batch failed to finish successfully,
|
||||
executing any callbacks if necessary.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $jobId
|
||||
|
||||
# * @param \Throwable $e
|
||||
|
||||
# * @return void'
|
||||
- name: incrementFailedJobs
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: jobId
|
||||
comment: '# * Increment the failed jobs for the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $jobId
|
||||
|
||||
# * @return \Illuminate\Bus\UpdatedBatchJobCounts'
|
||||
- name: hasCatchCallbacks
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the batch has "catch" callbacks.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: hasFinallyCallbacks
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the batch has "finally" callbacks.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: cancel
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Cancel the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: canceled
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the batch has been cancelled.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: cancelled
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the batch has been cancelled.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: delete
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Delete the batch from storage.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: invokeHandlerCallback
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: handler
|
||||
- name: batch
|
||||
- name: e
|
||||
default: 'null'
|
||||
comment: '# * Invoke a batch callback handler.
|
||||
|
||||
# *
|
||||
|
||||
# * @param callable $handler
|
||||
|
||||
# * @param \Illuminate\Bus\Batch $batch
|
||||
|
||||
# * @param \Throwable|null $e
|
||||
|
||||
# * @return void'
|
||||
- name: toArray
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Convert the batch to an array.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
- name: jsonSerialize
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the JSON serializable representation of the object.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
- name: __get
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
comment: '# * Dynamically access the batch''s "options" via properties.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @return mixed'
|
||||
traits:
|
||||
- Carbon\CarbonImmutable
|
||||
- Closure
|
||||
- Illuminate\Contracts\Support\Arrayable
|
||||
- Illuminate\Queue\CallQueuedClosure
|
||||
- Illuminate\Support\Arr
|
||||
- Illuminate\Support\Collection
|
||||
- JsonSerializable
|
||||
- Throwable
|
||||
interfaces:
|
||||
- Arrayable
|
||||
|
|
@ -1,70 +0,0 @@
|
|||
name: BatchFactory
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: CarbonImmutable
|
||||
type: class
|
||||
source: Carbon\CarbonImmutable
|
||||
- name: QueueFactory
|
||||
type: class
|
||||
source: Illuminate\Contracts\Queue\Factory
|
||||
properties:
|
||||
- name: queue
|
||||
visibility: protected
|
||||
comment: '# * The queue factory implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Queue\Factory'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: queue
|
||||
comment: "# * The queue factory implementation.\n# *\n# * @var \\Illuminate\\Contracts\\\
|
||||
Queue\\Factory\n# */\n# protected $queue;\n# \n# /**\n# * Create a new batch factory\
|
||||
\ instance.\n# *\n# * @param \\Illuminate\\Contracts\\Queue\\Factory $queue\n\
|
||||
# * @return void"
|
||||
- name: make
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: repository
|
||||
- name: id
|
||||
- name: name
|
||||
- name: totalJobs
|
||||
- name: pendingJobs
|
||||
- name: failedJobs
|
||||
- name: failedJobIds
|
||||
- name: options
|
||||
- name: createdAt
|
||||
- name: cancelledAt
|
||||
- name: finishedAt
|
||||
comment: '# * Create a new batch instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Bus\BatchRepository $repository
|
||||
|
||||
# * @param string $id
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @param int $totalJobs
|
||||
|
||||
# * @param int $pendingJobs
|
||||
|
||||
# * @param int $failedJobs
|
||||
|
||||
# * @param array $failedJobIds
|
||||
|
||||
# * @param array $options
|
||||
|
||||
# * @param \Carbon\CarbonImmutable $createdAt
|
||||
|
||||
# * @param \Carbon\CarbonImmutable|null $cancelledAt
|
||||
|
||||
# * @param \Carbon\CarbonImmutable|null $finishedAt
|
||||
|
||||
# * @return \Illuminate\Bus\Batch'
|
||||
traits:
|
||||
- Carbon\CarbonImmutable
|
||||
interfaces: []
|
||||
|
|
@ -1,141 +0,0 @@
|
|||
name: BatchRepository
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
properties: []
|
||||
methods:
|
||||
- name: get
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: limit
|
||||
- name: before
|
||||
comment: '# * Retrieve a list of batches.
|
||||
|
||||
# *
|
||||
|
||||
# * @param int $limit
|
||||
|
||||
# * @param mixed $before
|
||||
|
||||
# * @return \Illuminate\Bus\Batch[]'
|
||||
- name: find
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
comment: '# * Retrieve information about an existing batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @return \Illuminate\Bus\Batch|null'
|
||||
- name: store
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batch
|
||||
comment: '# * Store a new pending batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Bus\PendingBatch $batch
|
||||
|
||||
# * @return \Illuminate\Bus\Batch'
|
||||
- name: incrementTotalJobs
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
- name: amount
|
||||
comment: '# * Increment the total number of jobs within the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @param int $amount
|
||||
|
||||
# * @return void'
|
||||
- name: decrementPendingJobs
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
- name: jobId
|
||||
comment: '# * Decrement the total number of pending jobs for the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @param string $jobId
|
||||
|
||||
# * @return \Illuminate\Bus\UpdatedBatchJobCounts'
|
||||
- name: incrementFailedJobs
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
- name: jobId
|
||||
comment: '# * Increment the total number of failed jobs for the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @param string $jobId
|
||||
|
||||
# * @return \Illuminate\Bus\UpdatedBatchJobCounts'
|
||||
- name: markAsFinished
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
comment: '# * Mark the batch that has the given ID as finished.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @return void'
|
||||
- name: cancel
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
comment: '# * Cancel the batch that has the given ID.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @return void'
|
||||
- name: delete
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
comment: '# * Delete the batch that has the given ID.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @return void'
|
||||
- name: transaction
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Execute the given Closure within a storage specific transaction.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Closure $callback
|
||||
|
||||
# * @return mixed'
|
||||
- name: rollBack
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Rollback the last database transaction for the connection.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Closure
|
||||
interfaces: []
|
||||
|
|
@ -1,112 +0,0 @@
|
|||
name: Batchable
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: CarbonImmutable
|
||||
type: class
|
||||
source: Carbon\CarbonImmutable
|
||||
- name: Container
|
||||
type: class
|
||||
source: Illuminate\Container\Container
|
||||
- name: Str
|
||||
type: class
|
||||
source: Illuminate\Support\Str
|
||||
- name: BatchFake
|
||||
type: class
|
||||
source: Illuminate\Support\Testing\Fakes\BatchFake
|
||||
properties:
|
||||
- name: batchId
|
||||
visibility: public
|
||||
comment: '# * The batch ID (if applicable).
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: fakeBatch
|
||||
visibility: private
|
||||
comment: '# * The fake batch, if applicable.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Support\Testing\Fakes\BatchFake'
|
||||
methods:
|
||||
- name: batch
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: "# * The batch ID (if applicable).\n# *\n# * @var string\n# */\n# public\
|
||||
\ $batchId;\n# \n# /**\n# * The fake batch, if applicable.\n# *\n# * @var \\Illuminate\\\
|
||||
Support\\Testing\\Fakes\\BatchFake\n# */\n# private $fakeBatch;\n# \n# /**\n#\
|
||||
\ * Get the batch instance for the job, if applicable.\n# *\n# * @return \\Illuminate\\\
|
||||
Bus\\Batch|null"
|
||||
- name: batching
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the batch is still active and processing.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: withBatchId
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
comment: '# * Set the batch ID on the job.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @return $this'
|
||||
- name: withFakeBatch
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: id
|
||||
default: ''''''
|
||||
- name: name
|
||||
default: ''''''
|
||||
- name: totalJobs
|
||||
default: '0'
|
||||
- name: pendingJobs
|
||||
default: '0'
|
||||
- name: failedJobs
|
||||
default: '0'
|
||||
- name: failedJobIds
|
||||
default: '[]'
|
||||
- name: options
|
||||
default: '[]'
|
||||
- name: createdAt
|
||||
default: 'null'
|
||||
- name: cancelledAt
|
||||
default: 'null'
|
||||
- name: finishedAt
|
||||
default: 'null'
|
||||
comment: '# * Indicate that the job should use a fake batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $id
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @param int $totalJobs
|
||||
|
||||
# * @param int $pendingJobs
|
||||
|
||||
# * @param int $failedJobs
|
||||
|
||||
# * @param array $failedJobIds
|
||||
|
||||
# * @param array $options
|
||||
|
||||
# * @param \Carbon\CarbonImmutable|null $createdAt
|
||||
|
||||
# * @param \Carbon\CarbonImmutable|null $cancelledAt
|
||||
|
||||
# * @param \Carbon\CarbonImmutable|null $finishedAt
|
||||
|
||||
# * @return array{0: $this, 1: \Illuminate\Support\Testing\Fakes\BatchFake}'
|
||||
traits:
|
||||
- Carbon\CarbonImmutable
|
||||
- Illuminate\Container\Container
|
||||
- Illuminate\Support\Str
|
||||
- Illuminate\Support\Testing\Fakes\BatchFake
|
||||
interfaces: []
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
name: BusServiceProvider
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: DynamoDbClient
|
||||
type: class
|
||||
source: Aws\DynamoDb\DynamoDbClient
|
||||
- name: DispatcherContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Bus\Dispatcher
|
||||
- name: QueueingDispatcherContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Bus\QueueingDispatcher
|
||||
- name: QueueFactoryContract
|
||||
type: class
|
||||
source: Illuminate\Contracts\Queue\Factory
|
||||
- name: DeferrableProvider
|
||||
type: class
|
||||
source: Illuminate\Contracts\Support\DeferrableProvider
|
||||
- name: Arr
|
||||
type: class
|
||||
source: Illuminate\Support\Arr
|
||||
- name: ServiceProvider
|
||||
type: class
|
||||
source: Illuminate\Support\ServiceProvider
|
||||
properties: []
|
||||
methods:
|
||||
- name: register
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Register the service provider.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: registerBatchServices
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Register the batch handling services.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: provides
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the services provided by the provider.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
traits:
|
||||
- Aws\DynamoDb\DynamoDbClient
|
||||
- Illuminate\Contracts\Support\DeferrableProvider
|
||||
- Illuminate\Support\Arr
|
||||
- Illuminate\Support\ServiceProvider
|
||||
interfaces:
|
||||
- DeferrableProvider
|
||||
|
|
@ -1,85 +0,0 @@
|
|||
name: ChainedBatch
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Container
|
||||
type: class
|
||||
source: Illuminate\Container\Container
|
||||
- name: Dispatcher
|
||||
type: class
|
||||
source: Illuminate\Contracts\Bus\Dispatcher
|
||||
- name: ShouldQueue
|
||||
type: class
|
||||
source: Illuminate\Contracts\Queue\ShouldQueue
|
||||
- name: Dispatchable
|
||||
type: class
|
||||
source: Illuminate\Foundation\Bus\Dispatchable
|
||||
- name: InteractsWithQueue
|
||||
type: class
|
||||
source: Illuminate\Queue\InteractsWithQueue
|
||||
- name: Collection
|
||||
type: class
|
||||
source: Illuminate\Support\Collection
|
||||
- name: Throwable
|
||||
type: class
|
||||
source: Throwable
|
||||
properties: []
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batch
|
||||
comment: "# * The collection of batched jobs.\n# *\n# * @var \\Illuminate\\Support\\\
|
||||
Collection\n# */\n# public Collection $jobs;\n# \n# /**\n# * The name of the batch.\n\
|
||||
# *\n# * @var string\n# */\n# public string $name;\n# \n# /**\n# * The batch options.\n\
|
||||
# *\n# * @var array\n# */\n# public array $options;\n# \n# /**\n# * Create a new\
|
||||
\ chained batch instance.\n# *\n# * @param \\Illuminate\\Bus\\PendingBatch $batch\n\
|
||||
# * @return void"
|
||||
- name: prepareNestedBatches
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: jobs
|
||||
comment: '# * Prepare any nested batches within the given collection of jobs.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Support\Collection $jobs
|
||||
|
||||
# * @return \Illuminate\Support\Collection'
|
||||
- name: handle
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Handle the job.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: toPendingBatch
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Convert the chained batch instance into a pending batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Bus\PendingBatch'
|
||||
- name: attachRemainderOfChainToEndOfBatch
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: batch
|
||||
comment: '# * Move the remainder of the chain to a "finally" batch callback.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Bus\PendingBatch $batch
|
||||
|
||||
# * @return \Illuminate\Bus\PendingBatch'
|
||||
traits:
|
||||
- Illuminate\Container\Container
|
||||
- Illuminate\Contracts\Bus\Dispatcher
|
||||
- Illuminate\Contracts\Queue\ShouldQueue
|
||||
- Illuminate\Foundation\Bus\Dispatchable
|
||||
- Illuminate\Queue\InteractsWithQueue
|
||||
- Illuminate\Support\Collection
|
||||
- Throwable
|
||||
- Batchable
|
||||
interfaces:
|
||||
- ShouldQueue
|
||||
|
|
@ -1,305 +0,0 @@
|
|||
name: DatabaseBatchRepository
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: CarbonImmutable
|
||||
type: class
|
||||
source: Carbon\CarbonImmutable
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: DateTimeInterface
|
||||
type: class
|
||||
source: DateTimeInterface
|
||||
- name: Connection
|
||||
type: class
|
||||
source: Illuminate\Database\Connection
|
||||
- name: PostgresConnection
|
||||
type: class
|
||||
source: Illuminate\Database\PostgresConnection
|
||||
- name: Expression
|
||||
type: class
|
||||
source: Illuminate\Database\Query\Expression
|
||||
- name: Str
|
||||
type: class
|
||||
source: Illuminate\Support\Str
|
||||
- name: Throwable
|
||||
type: class
|
||||
source: Throwable
|
||||
properties:
|
||||
- name: factory
|
||||
visibility: protected
|
||||
comment: '# * The batch factory instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Bus\BatchFactory'
|
||||
- name: connection
|
||||
visibility: protected
|
||||
comment: '# * The database connection instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Database\Connection'
|
||||
- name: table
|
||||
visibility: protected
|
||||
comment: '# * The database table to use to store batch information.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: factory
|
||||
- name: connection
|
||||
- name: table
|
||||
comment: "# * The batch factory instance.\n# *\n# * @var \\Illuminate\\Bus\\BatchFactory\n\
|
||||
# */\n# protected $factory;\n# \n# /**\n# * The database connection instance.\n\
|
||||
# *\n# * @var \\Illuminate\\Database\\Connection\n# */\n# protected $connection;\n\
|
||||
# \n# /**\n# * The database table to use to store batch information.\n# *\n# *\
|
||||
\ @var string\n# */\n# protected $table;\n# \n# /**\n# * Create a new batch repository\
|
||||
\ instance.\n# *\n# * @param \\Illuminate\\Bus\\BatchFactory $factory\n# * @param\
|
||||
\ \\Illuminate\\Database\\Connection $connection\n# * @param string $table"
|
||||
- name: get
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: limit
|
||||
default: '50'
|
||||
- name: before
|
||||
default: 'null'
|
||||
comment: '# * Retrieve a list of batches.
|
||||
|
||||
# *
|
||||
|
||||
# * @param int $limit
|
||||
|
||||
# * @param mixed $before
|
||||
|
||||
# * @return \Illuminate\Bus\Batch[]'
|
||||
- name: find
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
comment: '# * Retrieve information about an existing batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @return \Illuminate\Bus\Batch|null'
|
||||
- name: store
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batch
|
||||
comment: '# * Store a new pending batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Bus\PendingBatch $batch
|
||||
|
||||
# * @return \Illuminate\Bus\Batch'
|
||||
- name: incrementTotalJobs
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
- name: amount
|
||||
comment: '# * Increment the total number of jobs within the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @param int $amount
|
||||
|
||||
# * @return void'
|
||||
- name: decrementPendingJobs
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
- name: jobId
|
||||
comment: '# * Decrement the total number of pending jobs for the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @param string $jobId
|
||||
|
||||
# * @return \Illuminate\Bus\UpdatedBatchJobCounts'
|
||||
- name: incrementFailedJobs
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
- name: jobId
|
||||
comment: '# * Increment the total number of failed jobs for the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @param string $jobId
|
||||
|
||||
# * @return \Illuminate\Bus\UpdatedBatchJobCounts'
|
||||
- name: updateAtomicValues
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: batchId
|
||||
- name: callback
|
||||
comment: '# * Update an atomic value within the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @param \Closure $callback
|
||||
|
||||
# * @return int|null'
|
||||
- name: markAsFinished
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
comment: '# * Mark the batch that has the given ID as finished.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @return void'
|
||||
- name: cancel
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
comment: '# * Cancel the batch that has the given ID.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @return void'
|
||||
- name: delete
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
comment: '# * Delete the batch that has the given ID.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @return void'
|
||||
- name: prune
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: before
|
||||
comment: '# * Prune all of the entries older than the given date.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \DateTimeInterface $before
|
||||
|
||||
# * @return int'
|
||||
- name: pruneUnfinished
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: before
|
||||
comment: '# * Prune all of the unfinished entries older than the given date.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \DateTimeInterface $before
|
||||
|
||||
# * @return int'
|
||||
- name: pruneCancelled
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: before
|
||||
comment: '# * Prune all of the cancelled entries older than the given date.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \DateTimeInterface $before
|
||||
|
||||
# * @return int'
|
||||
- name: transaction
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Execute the given Closure within a storage specific transaction.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Closure $callback
|
||||
|
||||
# * @return mixed'
|
||||
- name: rollBack
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Rollback the last database transaction for the connection.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: serialize
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: value
|
||||
comment: '# * Serialize the given value.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @return string'
|
||||
- name: unserialize
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: serialized
|
||||
comment: '# * Unserialize the given value.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $serialized
|
||||
|
||||
# * @return mixed'
|
||||
- name: toBatch
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: batch
|
||||
comment: '# * Convert the given raw batch to a Batch object.
|
||||
|
||||
# *
|
||||
|
||||
# * @param object $batch
|
||||
|
||||
# * @return \Illuminate\Bus\Batch'
|
||||
- name: getConnection
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the underlying database connection.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Database\Connection'
|
||||
- name: setConnection
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: connection
|
||||
comment: '# * Set the underlying database connection.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Database\Connection $connection
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Carbon\CarbonImmutable
|
||||
- Closure
|
||||
- DateTimeInterface
|
||||
- Illuminate\Database\Connection
|
||||
- Illuminate\Database\PostgresConnection
|
||||
- Illuminate\Database\Query\Expression
|
||||
- Illuminate\Support\Str
|
||||
- Throwable
|
||||
interfaces:
|
||||
- PrunableBatchRepository
|
||||
|
|
@ -1,282 +0,0 @@
|
|||
name: Dispatcher
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: QueueingDispatcher
|
||||
type: class
|
||||
source: Illuminate\Contracts\Bus\QueueingDispatcher
|
||||
- name: Container
|
||||
type: class
|
||||
source: Illuminate\Contracts\Container\Container
|
||||
- name: Queue
|
||||
type: class
|
||||
source: Illuminate\Contracts\Queue\Queue
|
||||
- name: ShouldQueue
|
||||
type: class
|
||||
source: Illuminate\Contracts\Queue\ShouldQueue
|
||||
- name: PendingChain
|
||||
type: class
|
||||
source: Illuminate\Foundation\Bus\PendingChain
|
||||
- name: Pipeline
|
||||
type: class
|
||||
source: Illuminate\Pipeline\Pipeline
|
||||
- name: InteractsWithQueue
|
||||
type: class
|
||||
source: Illuminate\Queue\InteractsWithQueue
|
||||
- name: SyncJob
|
||||
type: class
|
||||
source: Illuminate\Queue\Jobs\SyncJob
|
||||
- name: Collection
|
||||
type: class
|
||||
source: Illuminate\Support\Collection
|
||||
- name: RuntimeException
|
||||
type: class
|
||||
source: RuntimeException
|
||||
properties:
|
||||
- name: container
|
||||
visibility: protected
|
||||
comment: '# * The container implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Container\Container'
|
||||
- name: pipeline
|
||||
visibility: protected
|
||||
comment: '# * The pipeline instance for the bus.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Pipeline\Pipeline'
|
||||
- name: pipes
|
||||
visibility: protected
|
||||
comment: '# * The pipes to send commands through before dispatching.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: handlers
|
||||
visibility: protected
|
||||
comment: '# * The command to handler mapping for non-self-handling events.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: queueResolver
|
||||
visibility: protected
|
||||
comment: '# * The queue resolver callback.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Closure|null'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: container
|
||||
- name: queueResolver
|
||||
default: 'null'
|
||||
comment: "# * The container implementation.\n# *\n# * @var \\Illuminate\\Contracts\\\
|
||||
Container\\Container\n# */\n# protected $container;\n# \n# /**\n# * The pipeline\
|
||||
\ instance for the bus.\n# *\n# * @var \\Illuminate\\Pipeline\\Pipeline\n# */\n\
|
||||
# protected $pipeline;\n# \n# /**\n# * The pipes to send commands through before\
|
||||
\ dispatching.\n# *\n# * @var array\n# */\n# protected $pipes = [];\n# \n# /**\n\
|
||||
# * The command to handler mapping for non-self-handling events.\n# *\n# * @var\
|
||||
\ array\n# */\n# protected $handlers = [];\n# \n# /**\n# * The queue resolver\
|
||||
\ callback.\n# *\n# * @var \\Closure|null\n# */\n# protected $queueResolver;\n\
|
||||
# \n# /**\n# * Create a new command dispatcher instance.\n# *\n# * @param \\\
|
||||
Illuminate\\Contracts\\Container\\Container $container\n# * @param \\Closure|null\
|
||||
\ $queueResolver\n# * @return void"
|
||||
- name: dispatch
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: command
|
||||
comment: '# * Dispatch a command to its appropriate handler.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $command
|
||||
|
||||
# * @return mixed'
|
||||
- name: dispatchSync
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: command
|
||||
- name: handler
|
||||
default: 'null'
|
||||
comment: '# * Dispatch a command to its appropriate handler in the current process.
|
||||
|
||||
# *
|
||||
|
||||
# * Queueable jobs will be dispatched to the "sync" queue.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $command
|
||||
|
||||
# * @param mixed $handler
|
||||
|
||||
# * @return mixed'
|
||||
- name: dispatchNow
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: command
|
||||
- name: handler
|
||||
default: 'null'
|
||||
comment: '# * Dispatch a command to its appropriate handler in the current process
|
||||
without using the synchronous queue.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $command
|
||||
|
||||
# * @param mixed $handler
|
||||
|
||||
# * @return mixed'
|
||||
- name: findBatch
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
comment: '# * Attempt to find the batch with the given ID.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @return \Illuminate\Bus\Batch|null'
|
||||
- name: batch
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: jobs
|
||||
comment: '# * Create a new batch of queueable jobs.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Support\Collection|array|mixed $jobs
|
||||
|
||||
# * @return \Illuminate\Bus\PendingBatch'
|
||||
- name: chain
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: jobs
|
||||
comment: '# * Create a new chain of queueable jobs.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Support\Collection|array $jobs
|
||||
|
||||
# * @return \Illuminate\Foundation\Bus\PendingChain'
|
||||
- name: hasCommandHandler
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: command
|
||||
comment: '# * Determine if the given command has a handler.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $command
|
||||
|
||||
# * @return bool'
|
||||
- name: getCommandHandler
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: command
|
||||
comment: '# * Retrieve the handler for a command.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $command
|
||||
|
||||
# * @return bool|mixed'
|
||||
- name: commandShouldBeQueued
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: command
|
||||
comment: '# * Determine if the given command should be queued.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $command
|
||||
|
||||
# * @return bool'
|
||||
- name: dispatchToQueue
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: command
|
||||
comment: '# * Dispatch a command to its appropriate handler behind a queue.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $command
|
||||
|
||||
# * @return mixed
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \RuntimeException'
|
||||
- name: pushCommandToQueue
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: queue
|
||||
- name: command
|
||||
comment: '# * Push the command onto the given queue instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Contracts\Queue\Queue $queue
|
||||
|
||||
# * @param mixed $command
|
||||
|
||||
# * @return mixed'
|
||||
- name: dispatchAfterResponse
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: command
|
||||
- name: handler
|
||||
default: 'null'
|
||||
comment: '# * Dispatch a command to its appropriate handler after the current process.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $command
|
||||
|
||||
# * @param mixed $handler
|
||||
|
||||
# * @return void'
|
||||
- name: pipeThrough
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: pipes
|
||||
comment: '# * Set the pipes through which commands should be piped before dispatching.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $pipes
|
||||
|
||||
# * @return $this'
|
||||
- name: map
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: map
|
||||
comment: '# * Map a command to a handler.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $map
|
||||
|
||||
# * @return $this'
|
||||
traits:
|
||||
- Closure
|
||||
- Illuminate\Contracts\Bus\QueueingDispatcher
|
||||
- Illuminate\Contracts\Container\Container
|
||||
- Illuminate\Contracts\Queue\Queue
|
||||
- Illuminate\Contracts\Queue\ShouldQueue
|
||||
- Illuminate\Foundation\Bus\PendingChain
|
||||
- Illuminate\Pipeline\Pipeline
|
||||
- Illuminate\Queue\InteractsWithQueue
|
||||
- Illuminate\Queue\Jobs\SyncJob
|
||||
- Illuminate\Support\Collection
|
||||
- RuntimeException
|
||||
interfaces:
|
||||
- QueueingDispatcher
|
||||
|
|
@ -1,306 +0,0 @@
|
|||
name: DynamoBatchRepository
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: DynamoDbClient
|
||||
type: class
|
||||
source: Aws\DynamoDb\DynamoDbClient
|
||||
- name: Marshaler
|
||||
type: class
|
||||
source: Aws\DynamoDb\Marshaler
|
||||
- name: CarbonImmutable
|
||||
type: class
|
||||
source: Carbon\CarbonImmutable
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: Str
|
||||
type: class
|
||||
source: Illuminate\Support\Str
|
||||
properties:
|
||||
- name: factory
|
||||
visibility: protected
|
||||
comment: '# * The batch factory instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Bus\BatchFactory'
|
||||
- name: dynamoDbClient
|
||||
visibility: protected
|
||||
comment: '# * The database connection instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Aws\DynamoDb\DynamoDbClient'
|
||||
- name: applicationName
|
||||
visibility: protected
|
||||
comment: '# * The application name.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: table
|
||||
visibility: protected
|
||||
comment: '# * The table to use to store batch information.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: ttl
|
||||
visibility: protected
|
||||
comment: '# * The time-to-live value for batch records.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
- name: ttlAttribute
|
||||
visibility: protected
|
||||
comment: '# * The name of the time-to-live attribute for batch records.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: marshaler
|
||||
visibility: protected
|
||||
comment: '# * The DynamoDB marshaler instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Aws\DynamoDb\Marshaler'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: factory
|
||||
- name: dynamoDbClient
|
||||
- name: applicationName
|
||||
- name: table
|
||||
- name: ttl
|
||||
- name: ttlAttribute
|
||||
comment: "# * The batch factory instance.\n# *\n# * @var \\Illuminate\\Bus\\BatchFactory\n\
|
||||
# */\n# protected $factory;\n# \n# /**\n# * The database connection instance.\n\
|
||||
# *\n# * @var \\Aws\\DynamoDb\\DynamoDbClient\n# */\n# protected $dynamoDbClient;\n\
|
||||
# \n# /**\n# * The application name.\n# *\n# * @var string\n# */\n# protected\
|
||||
\ $applicationName;\n# \n# /**\n# * The table to use to store batch information.\n\
|
||||
# *\n# * @var string\n# */\n# protected $table;\n# \n# /**\n# * The time-to-live\
|
||||
\ value for batch records.\n# *\n# * @var int\n# */\n# protected $ttl;\n# \n#\
|
||||
\ /**\n# * The name of the time-to-live attribute for batch records.\n# *\n# *\
|
||||
\ @var string\n# */\n# protected $ttlAttribute;\n# \n# /**\n# * The DynamoDB marshaler\
|
||||
\ instance.\n# *\n# * @var \\Aws\\DynamoDb\\Marshaler\n# */\n# protected $marshaler;\n\
|
||||
# \n# /**\n# * Create a new batch repository instance."
|
||||
- name: get
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: limit
|
||||
default: '50'
|
||||
- name: before
|
||||
default: 'null'
|
||||
comment: '# * Retrieve a list of batches.
|
||||
|
||||
# *
|
||||
|
||||
# * @param int $limit
|
||||
|
||||
# * @param mixed $before
|
||||
|
||||
# * @return \Illuminate\Bus\Batch[]'
|
||||
- name: find
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
comment: '# * Retrieve information about an existing batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @return \Illuminate\Bus\Batch|null'
|
||||
- name: store
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batch
|
||||
comment: '# * Store a new pending batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Bus\PendingBatch $batch
|
||||
|
||||
# * @return \Illuminate\Bus\Batch'
|
||||
- name: incrementTotalJobs
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
- name: amount
|
||||
comment: '# * Increment the total number of jobs within the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @param int $amount
|
||||
|
||||
# * @return void'
|
||||
- name: decrementPendingJobs
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
- name: jobId
|
||||
comment: '# * Decrement the total number of pending jobs for the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @param string $jobId
|
||||
|
||||
# * @return \Illuminate\Bus\UpdatedBatchJobCounts'
|
||||
- name: incrementFailedJobs
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
- name: jobId
|
||||
comment: '# * Increment the total number of failed jobs for the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @param string $jobId
|
||||
|
||||
# * @return \Illuminate\Bus\UpdatedBatchJobCounts'
|
||||
- name: markAsFinished
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
comment: '# * Mark the batch that has the given ID as finished.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @return void'
|
||||
- name: cancel
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
comment: '# * Cancel the batch that has the given ID.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @return void'
|
||||
- name: delete
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batchId
|
||||
comment: '# * Delete the batch that has the given ID.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $batchId
|
||||
|
||||
# * @return void'
|
||||
- name: transaction
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Execute the given Closure within a storage specific transaction.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Closure $callback
|
||||
|
||||
# * @return mixed'
|
||||
- name: rollBack
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Rollback the last database transaction for the connection.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: toBatch
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: batch
|
||||
comment: '# * Convert the given raw batch to a Batch object.
|
||||
|
||||
# *
|
||||
|
||||
# * @param object $batch
|
||||
|
||||
# * @return \Illuminate\Bus\Batch'
|
||||
- name: createAwsDynamoTable
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Create the underlying DynamoDB table.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: deleteAwsDynamoTable
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Delete the underlying DynamoDB table.'
|
||||
- name: getExpiryTime
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Get the expiry time based on the configured time-to-live.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string|null'
|
||||
- name: ttlExpressionAttributeName
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Get the expression attribute name for the time-to-live attribute.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
- name: serialize
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: value
|
||||
comment: '# * Serialize the given value.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @return string'
|
||||
- name: unserialize
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: serialized
|
||||
comment: '# * Unserialize the given value.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $serialized
|
||||
|
||||
# * @return mixed'
|
||||
- name: getDynamoClient
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the underlying DynamoDB client instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Aws\DynamoDb\DynamoDbClient'
|
||||
- name: getTable
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * The name of the table that contains the batch records.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
traits:
|
||||
- Aws\DynamoDb\DynamoDbClient
|
||||
- Aws\DynamoDb\Marshaler
|
||||
- Carbon\CarbonImmutable
|
||||
- Closure
|
||||
- Illuminate\Support\Str
|
||||
interfaces:
|
||||
- BatchRepository
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
name: BatchDispatched
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Batch
|
||||
type: class
|
||||
source: Illuminate\Bus\Batch
|
||||
properties:
|
||||
- name: batch
|
||||
visibility: public
|
||||
comment: '# * The batch instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Bus\Batch'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: batch
|
||||
comment: "# * The batch instance.\n# *\n# * @var \\Illuminate\\Bus\\Batch\n# */\n\
|
||||
# public $batch;\n# \n# /**\n# * Create a new event instance.\n# *\n# * @param\
|
||||
\ \\Illuminate\\Bus\\Batch $batch\n# * @return void"
|
||||
traits:
|
||||
- Illuminate\Bus\Batch
|
||||
interfaces: []
|
||||
|
|
@ -1,353 +0,0 @@
|
|||
name: PendingBatch
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: BatchDispatched
|
||||
type: class
|
||||
source: Illuminate\Bus\Events\BatchDispatched
|
||||
- name: Container
|
||||
type: class
|
||||
source: Illuminate\Contracts\Container\Container
|
||||
- name: EventDispatcher
|
||||
type: class
|
||||
source: Illuminate\Contracts\Events\Dispatcher
|
||||
- name: Arr
|
||||
type: class
|
||||
source: Illuminate\Support\Arr
|
||||
- name: Collection
|
||||
type: class
|
||||
source: Illuminate\Support\Collection
|
||||
- name: Conditionable
|
||||
type: class
|
||||
source: Illuminate\Support\Traits\Conditionable
|
||||
- name: SerializableClosure
|
||||
type: class
|
||||
source: Laravel\SerializableClosure\SerializableClosure
|
||||
- name: Throwable
|
||||
type: class
|
||||
source: Throwable
|
||||
- name: Conditionable
|
||||
type: class
|
||||
source: Conditionable
|
||||
properties:
|
||||
- name: container
|
||||
visibility: protected
|
||||
comment: '# * The IoC container instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Container\Container'
|
||||
- name: name
|
||||
visibility: public
|
||||
comment: '# * The batch name.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
- name: jobs
|
||||
visibility: public
|
||||
comment: '# * The jobs that belong to the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Support\Collection'
|
||||
- name: options
|
||||
visibility: public
|
||||
comment: '# * The batch options.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: container
|
||||
- name: jobs
|
||||
comment: "# * The IoC container instance.\n# *\n# * @var \\Illuminate\\Contracts\\\
|
||||
Container\\Container\n# */\n# protected $container;\n# \n# /**\n# * The batch\
|
||||
\ name.\n# *\n# * @var string\n# */\n# public $name = '';\n# \n# /**\n# * The\
|
||||
\ jobs that belong to the batch.\n# *\n# * @var \\Illuminate\\Support\\Collection\n\
|
||||
# */\n# public $jobs;\n# \n# /**\n# * The batch options.\n# *\n# * @var array\n\
|
||||
# */\n# public $options = [];\n# \n# /**\n# * Create a new pending batch instance.\n\
|
||||
# *\n# * @param \\Illuminate\\Contracts\\Container\\Container $container\n#\
|
||||
\ * @param \\Illuminate\\Support\\Collection $jobs\n# * @return void"
|
||||
- name: add
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: jobs
|
||||
comment: '# * Add jobs to the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param iterable|object|array $jobs
|
||||
|
||||
# * @return $this'
|
||||
- name: before
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Add a callback to be executed when the batch is stored.
|
||||
|
||||
# *
|
||||
|
||||
# * @param callable $callback
|
||||
|
||||
# * @return $this'
|
||||
- name: beforeCallbacks
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the "before" callbacks that have been registered with the pending
|
||||
batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
- name: progress
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Add a callback to be executed after a job in the batch have executed
|
||||
successfully.
|
||||
|
||||
# *
|
||||
|
||||
# * @param callable $callback
|
||||
|
||||
# * @return $this'
|
||||
- name: progressCallbacks
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the "progress" callbacks that have been registered with the pending
|
||||
batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
- name: then
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Add a callback to be executed after all jobs in the batch have executed
|
||||
successfully.
|
||||
|
||||
# *
|
||||
|
||||
# * @param callable $callback
|
||||
|
||||
# * @return $this'
|
||||
- name: thenCallbacks
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the "then" callbacks that have been registered with the pending
|
||||
batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
- name: catch
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Add a callback to be executed after the first failing job in the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param callable $callback
|
||||
|
||||
# * @return $this'
|
||||
- name: catchCallbacks
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the "catch" callbacks that have been registered with the pending
|
||||
batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
- name: finally
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: callback
|
||||
comment: '# * Add a callback to be executed after the batch has finished executing.
|
||||
|
||||
# *
|
||||
|
||||
# * @param callable $callback
|
||||
|
||||
# * @return $this'
|
||||
- name: finallyCallbacks
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the "finally" callbacks that have been registered with the pending
|
||||
batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @return array'
|
||||
- name: allowFailures
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: allowFailures
|
||||
default: 'true'
|
||||
comment: '# * Indicate that the batch should not be cancelled when a job within
|
||||
the batch fails.
|
||||
|
||||
# *
|
||||
|
||||
# * @param bool $allowFailures
|
||||
|
||||
# * @return $this'
|
||||
- name: allowsFailures
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if the pending batch allows jobs to fail without cancelling
|
||||
the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: name
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
comment: '# * Set the name for the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @return $this'
|
||||
- name: onConnection
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: connection
|
||||
comment: '# * Specify the queue connection that the batched jobs should run on.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $connection
|
||||
|
||||
# * @return $this'
|
||||
- name: connection
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the connection used by the pending batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string|null'
|
||||
- name: onQueue
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: queue
|
||||
comment: '# * Specify the queue that the batched jobs should run on.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $queue
|
||||
|
||||
# * @return $this'
|
||||
- name: queue
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the queue used by the pending batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string|null'
|
||||
- name: withOption
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
comment: '# * Add additional data into the batch''s options array.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @return $this'
|
||||
- name: dispatch
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Dispatch the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Bus\Batch
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Throwable'
|
||||
- name: dispatchAfterResponse
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Dispatch the batch after the response is sent to the browser.
|
||||
|
||||
# *
|
||||
|
||||
# * @return \Illuminate\Bus\Batch'
|
||||
- name: dispatchExistingBatch
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: batch
|
||||
comment: '# * Dispatch an existing batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Bus\Batch $batch
|
||||
|
||||
# * @return void
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \Throwable'
|
||||
- name: dispatchIf
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: boolean
|
||||
comment: '# * Dispatch the batch if the given truth test passes.
|
||||
|
||||
# *
|
||||
|
||||
# * @param bool|\Closure $boolean
|
||||
|
||||
# * @return \Illuminate\Bus\Batch|null'
|
||||
- name: dispatchUnless
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: boolean
|
||||
comment: '# * Dispatch the batch unless the given truth test passes.
|
||||
|
||||
# *
|
||||
|
||||
# * @param bool|\Closure $boolean
|
||||
|
||||
# * @return \Illuminate\Bus\Batch|null'
|
||||
- name: store
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: repository
|
||||
comment: '# * Store the batch using the given repository.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Illuminate\Bus\BatchRepository $repository
|
||||
|
||||
# * @return \Illuminate\Bus\Batch'
|
||||
traits:
|
||||
- Closure
|
||||
- Illuminate\Bus\Events\BatchDispatched
|
||||
- Illuminate\Contracts\Container\Container
|
||||
- Illuminate\Support\Arr
|
||||
- Illuminate\Support\Collection
|
||||
- Illuminate\Support\Traits\Conditionable
|
||||
- Laravel\SerializableClosure\SerializableClosure
|
||||
- Throwable
|
||||
- Conditionable
|
||||
interfaces: []
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
name: PrunableBatchRepository
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: DateTimeInterface
|
||||
type: class
|
||||
source: DateTimeInterface
|
||||
properties: []
|
||||
methods:
|
||||
- name: prune
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: before
|
||||
comment: '# * Prune all of the entries older than the given date.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \DateTimeInterface $before
|
||||
|
||||
# * @return int'
|
||||
traits:
|
||||
- DateTimeInterface
|
||||
interfaces: []
|
||||
|
|
@ -1,279 +0,0 @@
|
|||
name: Queueable
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Closure
|
||||
type: class
|
||||
source: Closure
|
||||
- name: CallQueuedClosure
|
||||
type: class
|
||||
source: Illuminate\Queue\CallQueuedClosure
|
||||
- name: Arr
|
||||
type: class
|
||||
source: Illuminate\Support\Arr
|
||||
- name: PHPUnit
|
||||
type: class
|
||||
source: PHPUnit\Framework\Assert
|
||||
- name: RuntimeException
|
||||
type: class
|
||||
source: RuntimeException
|
||||
properties:
|
||||
- name: connection
|
||||
visibility: public
|
||||
comment: '# * The name of the connection the job should be sent to.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string|null'
|
||||
- name: queue
|
||||
visibility: public
|
||||
comment: '# * The name of the queue the job should be sent to.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string|null'
|
||||
- name: delay
|
||||
visibility: public
|
||||
comment: '# * The number of seconds before the job should be made available.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \DateTimeInterface|\DateInterval|array|int|null'
|
||||
- name: afterCommit
|
||||
visibility: public
|
||||
comment: '# * Indicates whether the job should be dispatched after all database
|
||||
transactions have committed.
|
||||
|
||||
# *
|
||||
|
||||
# * @var bool|null'
|
||||
- name: middleware
|
||||
visibility: public
|
||||
comment: '# * The middleware the job should be dispatched through.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: chained
|
||||
visibility: public
|
||||
comment: '# * The jobs that should run if this job is successful.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: chainConnection
|
||||
visibility: public
|
||||
comment: '# * The name of the connection the chain should be sent to.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string|null'
|
||||
- name: chainQueue
|
||||
visibility: public
|
||||
comment: '# * The name of the queue the chain should be sent to.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string|null'
|
||||
- name: chainCatchCallbacks
|
||||
visibility: public
|
||||
comment: '# * The callbacks to be executed on chain failure.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array|null'
|
||||
methods:
|
||||
- name: onConnection
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: connection
|
||||
comment: "# * The name of the connection the job should be sent to.\n# *\n# * @var\
|
||||
\ string|null\n# */\n# public $connection;\n# \n# /**\n# * The name of the queue\
|
||||
\ the job should be sent to.\n# *\n# * @var string|null\n# */\n# public $queue;\n\
|
||||
# \n# /**\n# * The number of seconds before the job should be made available.\n\
|
||||
# *\n# * @var \\DateTimeInterface|\\DateInterval|array|int|null\n# */\n# public\
|
||||
\ $delay;\n# \n# /**\n# * Indicates whether the job should be dispatched after\
|
||||
\ all database transactions have committed.\n# *\n# * @var bool|null\n# */\n#\
|
||||
\ public $afterCommit;\n# \n# /**\n# * The middleware the job should be dispatched\
|
||||
\ through.\n# *\n# * @var array\n# */\n# public $middleware = [];\n# \n# /**\n\
|
||||
# * The jobs that should run if this job is successful.\n# *\n# * @var array\n\
|
||||
# */\n# public $chained = [];\n# \n# /**\n# * The name of the connection the chain\
|
||||
\ should be sent to.\n# *\n# * @var string|null\n# */\n# public $chainConnection;\n\
|
||||
# \n# /**\n# * The name of the queue the chain should be sent to.\n# *\n# * @var\
|
||||
\ string|null\n# */\n# public $chainQueue;\n# \n# /**\n# * The callbacks to be\
|
||||
\ executed on chain failure.\n# *\n# * @var array|null\n# */\n# public $chainCatchCallbacks;\n\
|
||||
# \n# /**\n# * Set the desired connection for the job.\n# *\n# * @param string|null\
|
||||
\ $connection\n# * @return $this"
|
||||
- name: onQueue
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: queue
|
||||
comment: '# * Set the desired queue for the job.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $queue
|
||||
|
||||
# * @return $this'
|
||||
- name: allOnConnection
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: connection
|
||||
comment: '# * Set the desired connection for the chain.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $connection
|
||||
|
||||
# * @return $this'
|
||||
- name: allOnQueue
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: queue
|
||||
comment: '# * Set the desired queue for the chain.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string|null $queue
|
||||
|
||||
# * @return $this'
|
||||
- name: delay
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: delay
|
||||
comment: '# * Set the desired delay in seconds for the job.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \DateTimeInterface|\DateInterval|array|int|null $delay
|
||||
|
||||
# * @return $this'
|
||||
- name: withoutDelay
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Set the delay for the job to zero seconds.
|
||||
|
||||
# *
|
||||
|
||||
# * @return $this'
|
||||
- name: afterCommit
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Indicate that the job should be dispatched after all database transactions
|
||||
have committed.
|
||||
|
||||
# *
|
||||
|
||||
# * @return $this'
|
||||
- name: beforeCommit
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Indicate that the job should not wait until database transactions
|
||||
have been committed before dispatching.
|
||||
|
||||
# *
|
||||
|
||||
# * @return $this'
|
||||
- name: through
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: middleware
|
||||
comment: '# * Specify the middleware the job should be dispatched through.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array|object $middleware
|
||||
|
||||
# * @return $this'
|
||||
- name: chain
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: chain
|
||||
comment: '# * Set the jobs that should run if this job is successful.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $chain
|
||||
|
||||
# * @return $this'
|
||||
- name: prependToChain
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: job
|
||||
comment: '# * Prepend a job to the current chain so that it is run after the currently
|
||||
running job.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $job
|
||||
|
||||
# * @return $this'
|
||||
- name: appendToChain
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: job
|
||||
comment: '# * Append a job to the end of the current chain.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $job
|
||||
|
||||
# * @return $this'
|
||||
- name: serializeJob
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: job
|
||||
comment: '# * Serialize a job for queuing.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $job
|
||||
|
||||
# * @return string
|
||||
|
||||
# *
|
||||
|
||||
# * @throws \RuntimeException'
|
||||
- name: dispatchNextJobInChain
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Dispatch the next job on the chain.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: invokeChainCatchCallbacks
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: e
|
||||
comment: '# * Invoke all of the chain''s failed job callbacks.
|
||||
|
||||
# *
|
||||
|
||||
# * @param \Throwable $e
|
||||
|
||||
# * @return void'
|
||||
- name: assertHasChain
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: expectedChain
|
||||
comment: '# * Assert that the job has the given chain of jobs attached to it.
|
||||
|
||||
# *
|
||||
|
||||
# * @param array $expectedChain
|
||||
|
||||
# * @return void'
|
||||
- name: assertDoesntHaveChain
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Assert that the job has no remaining chained jobs.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Closure
|
||||
- Illuminate\Queue\CallQueuedClosure
|
||||
- Illuminate\Support\Arr
|
||||
- RuntimeException
|
||||
interfaces: []
|
||||
|
|
@ -1,58 +0,0 @@
|
|||
name: UniqueLock
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Cache
|
||||
type: class
|
||||
source: Illuminate\Contracts\Cache\Repository
|
||||
properties:
|
||||
- name: cache
|
||||
visibility: protected
|
||||
comment: '# * The cache repository implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Cache\Repository'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: cache
|
||||
comment: "# * The cache repository implementation.\n# *\n# * @var \\Illuminate\\\
|
||||
Contracts\\Cache\\Repository\n# */\n# protected $cache;\n# \n# /**\n# * Create\
|
||||
\ a new unique lock manager instance.\n# *\n# * @param \\Illuminate\\Contracts\\\
|
||||
Cache\\Repository $cache\n# * @return void"
|
||||
- name: acquire
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: job
|
||||
comment: '# * Attempt to acquire a lock for the given job.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $job
|
||||
|
||||
# * @return bool'
|
||||
- name: release
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: job
|
||||
comment: '# * Release the lock for the given job.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $job
|
||||
|
||||
# * @return void'
|
||||
- name: getKey
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: job
|
||||
comment: '# * Generate the lock key for the given job.
|
||||
|
||||
# *
|
||||
|
||||
# * @param mixed $job
|
||||
|
||||
# * @return string'
|
||||
traits: []
|
||||
interfaces: []
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
name: UpdatedBatchJobCounts
|
||||
class_comment: null
|
||||
dependencies: []
|
||||
properties:
|
||||
- name: pendingJobs
|
||||
visibility: public
|
||||
comment: '# * The number of pending jobs remaining for the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
- name: failedJobs
|
||||
visibility: public
|
||||
comment: '# * The number of failed jobs that belong to the batch.
|
||||
|
||||
# *
|
||||
|
||||
# * @var int'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: pendingJobs
|
||||
default: '0'
|
||||
- name: failedJobs
|
||||
default: '0'
|
||||
comment: "# * The number of pending jobs remaining for the batch.\n# *\n# * @var\
|
||||
\ int\n# */\n# public $pendingJobs;\n# \n# /**\n# * The number of failed jobs\
|
||||
\ that belong to the batch.\n# *\n# * @var int\n# */\n# public $failedJobs;\n\
|
||||
# \n# /**\n# * Create a new batch job counts object.\n# *\n# * @param int $pendingJobs\n\
|
||||
# * @param int $failedJobs\n# * @return void"
|
||||
- name: allJobsHaveRanExactlyOnce
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Determine if all jobs have run exactly once.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
traits: []
|
||||
interfaces: []
|
||||
|
|
@ -1,146 +0,0 @@
|
|||
name: ApcStore
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: RetrievesMultipleKeys
|
||||
type: class
|
||||
source: RetrievesMultipleKeys
|
||||
properties:
|
||||
- name: apc
|
||||
visibility: protected
|
||||
comment: '# * The APC wrapper instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Cache\ApcWrapper'
|
||||
- name: prefix
|
||||
visibility: protected
|
||||
comment: '# * A string that should be prepended to keys.
|
||||
|
||||
# *
|
||||
|
||||
# * @var string'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: apc
|
||||
- name: prefix
|
||||
default: ''''''
|
||||
comment: "# * The APC wrapper instance.\n# *\n# * @var \\Illuminate\\Cache\\ApcWrapper\n\
|
||||
# */\n# protected $apc;\n# \n# /**\n# * A string that should be prepended to keys.\n\
|
||||
# *\n# * @var string\n# */\n# protected $prefix;\n# \n# /**\n# * Create a new\
|
||||
\ APC store.\n# *\n# * @param \\Illuminate\\Cache\\ApcWrapper $apc\n# * @param\
|
||||
\ string $prefix\n# * @return void"
|
||||
- name: get
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
comment: '# * Retrieve an item from the cache by key.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @return mixed'
|
||||
- name: put
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
- name: seconds
|
||||
comment: '# * Store an item in the cache for a given number of seconds.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @param int $seconds
|
||||
|
||||
# * @return bool'
|
||||
- name: increment
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
default: '1'
|
||||
comment: '# * Increment the value of an item in the cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @return int|bool'
|
||||
- name: decrement
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
default: '1'
|
||||
comment: '# * Decrement the value of an item in the cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @return int|bool'
|
||||
- name: forever
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
comment: '# * Store an item in the cache indefinitely.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @return bool'
|
||||
- name: forget
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
comment: '# * Remove an item from the cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @return bool'
|
||||
- name: flush
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Remove all items from the cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: getPrefix
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the cache key prefix.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: setPrefix
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: prefix
|
||||
comment: '# * Set the cache key prefix.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $prefix
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- RetrievesMultipleKeys
|
||||
interfaces: []
|
||||
|
|
@ -1,82 +0,0 @@
|
|||
name: ApcWrapper
|
||||
class_comment: null
|
||||
dependencies: []
|
||||
properties: []
|
||||
methods:
|
||||
- name: get
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
comment: '# * Get an item from the cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @return mixed'
|
||||
- name: put
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
- name: seconds
|
||||
comment: '# * Store an item in the cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @param int $seconds
|
||||
|
||||
# * @return array|bool'
|
||||
- name: increment
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
comment: '# * Increment the value of an item in the cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @return int|bool'
|
||||
- name: decrement
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
comment: '# * Decrement the value of an item in the cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @return int|bool'
|
||||
- name: delete
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
comment: '# * Remove an item from the cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @return bool'
|
||||
- name: flush
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Remove all items from the cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
traits: []
|
||||
interfaces: []
|
||||
|
|
@ -1,71 +0,0 @@
|
|||
name: ArrayLock
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: Carbon
|
||||
type: class
|
||||
source: Illuminate\Support\Carbon
|
||||
properties:
|
||||
- name: store
|
||||
visibility: protected
|
||||
comment: '# * The parent array cache store.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Cache\ArrayStore'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: store
|
||||
- name: name
|
||||
- name: seconds
|
||||
- name: owner
|
||||
default: 'null'
|
||||
comment: "# * The parent array cache store.\n# *\n# * @var \\Illuminate\\Cache\\\
|
||||
ArrayStore\n# */\n# protected $store;\n# \n# /**\n# * Create a new lock instance.\n\
|
||||
# *\n# * @param \\Illuminate\\Cache\\ArrayStore $store\n# * @param string \
|
||||
\ $name\n# * @param int $seconds\n# * @param string|null $owner\n# * @return\
|
||||
\ void"
|
||||
- name: acquire
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Attempt to acquire the lock.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: exists
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Determine if the current lock exists.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: release
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Release the lock.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: getCurrentOwner
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Returns the owner value written into the driver for this lock.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: forceRelease
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Releases this lock in disregard of ownership.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
traits:
|
||||
- Illuminate\Support\Carbon
|
||||
interfaces: []
|
||||
|
|
@ -1,208 +0,0 @@
|
|||
name: ArrayStore
|
||||
class_comment: null
|
||||
dependencies:
|
||||
- name: LockProvider
|
||||
type: class
|
||||
source: Illuminate\Contracts\Cache\LockProvider
|
||||
- name: Carbon
|
||||
type: class
|
||||
source: Illuminate\Support\Carbon
|
||||
- name: InteractsWithTime
|
||||
type: class
|
||||
source: Illuminate\Support\InteractsWithTime
|
||||
properties:
|
||||
- name: storage
|
||||
visibility: protected
|
||||
comment: '# * The array of stored values.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: locks
|
||||
visibility: public
|
||||
comment: '# * The array of locks.
|
||||
|
||||
# *
|
||||
|
||||
# * @var array'
|
||||
- name: serializesValues
|
||||
visibility: protected
|
||||
comment: '# * Indicates if values are serialized within the store.
|
||||
|
||||
# *
|
||||
|
||||
# * @var bool'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: serializesValues
|
||||
default: 'false'
|
||||
comment: "# * The array of stored values.\n# *\n# * @var array\n# */\n# protected\
|
||||
\ $storage = [];\n# \n# /**\n# * The array of locks.\n# *\n# * @var array\n# */\n\
|
||||
# public $locks = [];\n# \n# /**\n# * Indicates if values are serialized within\
|
||||
\ the store.\n# *\n# * @var bool\n# */\n# protected $serializesValues;\n# \n#\
|
||||
\ /**\n# * Create a new Array store.\n# *\n# * @param bool $serializesValues\n\
|
||||
# * @return void"
|
||||
- name: get
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
comment: '# * Retrieve an item from the cache by key.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @return mixed'
|
||||
- name: put
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
- name: seconds
|
||||
comment: '# * Store an item in the cache for a given number of seconds.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @param int $seconds
|
||||
|
||||
# * @return bool'
|
||||
- name: increment
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
default: '1'
|
||||
comment: '# * Increment the value of an item in the cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @return int'
|
||||
- name: decrement
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
default: '1'
|
||||
comment: '# * Decrement the value of an item in the cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @return int'
|
||||
- name: forever
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
- name: value
|
||||
comment: '# * Store an item in the cache indefinitely.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @param mixed $value
|
||||
|
||||
# * @return bool'
|
||||
- name: forget
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: key
|
||||
comment: '# * Remove an item from the cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $key
|
||||
|
||||
# * @return bool'
|
||||
- name: flush
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Remove all items from the cache.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: getPrefix
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Get the cache key prefix.
|
||||
|
||||
# *
|
||||
|
||||
# * @return string'
|
||||
- name: calculateExpiration
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: seconds
|
||||
comment: '# * Get the expiration time of the key.
|
||||
|
||||
# *
|
||||
|
||||
# * @param int $seconds
|
||||
|
||||
# * @return float'
|
||||
- name: toTimestamp
|
||||
visibility: protected
|
||||
parameters:
|
||||
- name: seconds
|
||||
comment: '# * Get the UNIX timestamp, with milliseconds, for the given number of
|
||||
seconds in the future.
|
||||
|
||||
# *
|
||||
|
||||
# * @param int $seconds
|
||||
|
||||
# * @return float'
|
||||
- name: lock
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
- name: seconds
|
||||
default: '0'
|
||||
- name: owner
|
||||
default: 'null'
|
||||
comment: '# * Get a lock instance.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @param int $seconds
|
||||
|
||||
# * @param string|null $owner
|
||||
|
||||
# * @return \Illuminate\Contracts\Cache\Lock'
|
||||
- name: restoreLock
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: name
|
||||
- name: owner
|
||||
comment: '# * Restore a lock instance using the owner identifier.
|
||||
|
||||
# *
|
||||
|
||||
# * @param string $name
|
||||
|
||||
# * @param string $owner
|
||||
|
||||
# * @return \Illuminate\Contracts\Cache\Lock'
|
||||
traits:
|
||||
- Illuminate\Contracts\Cache\LockProvider
|
||||
- Illuminate\Support\Carbon
|
||||
- Illuminate\Support\InteractsWithTime
|
||||
- InteractsWithTime
|
||||
interfaces:
|
||||
- LockProvider
|
||||
|
|
@ -1,59 +0,0 @@
|
|||
name: CacheLock
|
||||
class_comment: null
|
||||
dependencies: []
|
||||
properties:
|
||||
- name: store
|
||||
visibility: protected
|
||||
comment: '# * The cache store implementation.
|
||||
|
||||
# *
|
||||
|
||||
# * @var \Illuminate\Contracts\Cache\Store'
|
||||
methods:
|
||||
- name: __construct
|
||||
visibility: public
|
||||
parameters:
|
||||
- name: store
|
||||
- name: name
|
||||
- name: seconds
|
||||
- name: owner
|
||||
default: 'null'
|
||||
comment: "# * The cache store implementation.\n# *\n# * @var \\Illuminate\\Contracts\\\
|
||||
Cache\\Store\n# */\n# protected $store;\n# \n# /**\n# * Create a new lock instance.\n\
|
||||
# *\n# * @param \\Illuminate\\Contracts\\Cache\\Store $store\n# * @param string\
|
||||
\ $name\n# * @param int $seconds\n# * @param string|null $owner\n# * @return\
|
||||
\ void"
|
||||
- name: acquire
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Attempt to acquire the lock.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: release
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Release the lock.
|
||||
|
||||
# *
|
||||
|
||||
# * @return bool'
|
||||
- name: forceRelease
|
||||
visibility: public
|
||||
parameters: []
|
||||
comment: '# * Releases this lock regardless of ownership.
|
||||
|
||||
# *
|
||||
|
||||
# * @return void'
|
||||
- name: getCurrentOwner
|
||||
visibility: protected
|
||||
parameters: []
|
||||
comment: '# * Returns the owner value written into the driver for this lock.
|
||||
|
||||
# *
|
||||
|
||||
# * @return mixed'
|
||||
traits: []
|
||||
interfaces: []
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue