code
stringlengths 17
296k
| docstring
stringlengths 30
30.3k
| func_name
stringlengths 1
89
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
153
| url
stringlengths 51
209
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function __construct()
{
parent::__construct('Serializer must be an instance of [' . SerializerAbstract::class . '].');
} | Construct the exception class. | __construct | php | flugg/laravel-responder | src/Exceptions/InvalidSuccessSerializerException.php | https://github.com/flugg/laravel-responder/blob/master/src/Exceptions/InvalidSuccessSerializerException.php | MIT |
public function __construct()
{
parent::__construct('Transformer must be a callable or an instance of [' . Transformer::class . '].');
} | Construct the exception class. | __construct | php | flugg/laravel-responder | src/Exceptions/InvalidTransformerException.php | https://github.com/flugg/laravel-responder/blob/master/src/Exceptions/InvalidTransformerException.php | MIT |
protected function convert($exception, array $convert)
{
foreach ($convert as $source => $target) {
if ($exception instanceof $source) {
if (is_callable($target)) {
$target($exception);
}
throw new $target;
}
}
} | Convert an exception to another exception
@param \Exception|\Throwable $exception
@param array $convert
@return void | convert | php | flugg/laravel-responder | src/Exceptions/ConvertsExceptions.php | https://github.com/flugg/laravel-responder/blob/master/src/Exceptions/ConvertsExceptions.php | MIT |
public function render($request, $exception)
{
if ($request->wantsJson()) {
$this->convertDefaultException($exception);
if ($exception instanceof HttpException) {
return $this->renderResponse($exception);
}
}
return parent::render($request, $exception);
} | Render an exception into an HTTP response.
@param \Illuminate\Http\Request $request
@param \Exception|\Throwable $exception
@return \Symfony\Component\HttpFoundation\Response | render | php | flugg/laravel-responder | src/Exceptions/Handler.php | https://github.com/flugg/laravel-responder/blob/master/src/Exceptions/Handler.php | MIT |
public function __construct(?string $message = null, ?array $headers = null)
{
parent::__construct($this->status, $message ?? $this->message, null, $headers ?? $this->headers);
} | Construct the exception class.
@param string|null $message
@param array|null $headers | __construct | php | flugg/laravel-responder | src/Exceptions/Http/HttpException.php | https://github.com/flugg/laravel-responder/blob/master/src/Exceptions/Http/HttpException.php | MIT |
public function data()
{
return $this->data;
} | Retrieve additional error data.
@return array|null | data | php | flugg/laravel-responder | src/Exceptions/Http/HttpException.php | https://github.com/flugg/laravel-responder/blob/master/src/Exceptions/Http/HttpException.php | MIT |
public function __construct(Validator $validator)
{
$this->validator = $validator;
parent::__construct();
} | Construct the exception class.
@param \Illuminate\Contracts\Validation\Validator $validator | __construct | php | flugg/laravel-responder | src/Exceptions/Http/ValidationFailedException.php | https://github.com/flugg/laravel-responder/blob/master/src/Exceptions/Http/ValidationFailedException.php | MIT |
protected function getStub()
{
if ($this->option('plain')) {
return __DIR__ . '/../../resources/stubs/transformer.plain.stub';
}
return __DIR__ . '/../../resources/stubs/transformer.model.stub';
} | Get the stub file for the generator.
@return string | getStub | php | flugg/laravel-responder | src/Console/MakeTransformer.php | https://github.com/flugg/laravel-responder/blob/master/src/Console/MakeTransformer.php | MIT |
protected function getDefaultNamespace($rootNamespace)
{
return $rootNamespace . '\Transformers';
} | Get the default namespace for the class.
@param string $rootNamespace
@return string | getDefaultNamespace | php | flugg/laravel-responder | src/Console/MakeTransformer.php | https://github.com/flugg/laravel-responder/blob/master/src/Console/MakeTransformer.php | MIT |
protected function buildClass($name)
{
$replace = [];
if (! $this->option('model') && ! $this->option('plain')) {
$this->input->setOption('model', $this->resolveModelFromClassName());
}
if ($this->option('model')) {
$replace = $this->buildModelReplacements($replace);
}
return str_replace(array_keys($replace), array_values($replace), parent::buildClass($name));
} | Build the class with the given name.
@param string $name
@return string | buildClass | php | flugg/laravel-responder | src/Console/MakeTransformer.php | https://github.com/flugg/laravel-responder/blob/master/src/Console/MakeTransformer.php | MIT |
protected function resolveModelFromClassName()
{
return 'App\\Models\\' . str_replace('Transformer', '', Arr::last(explode('/', $this->getNameInput())));
} | Resolve a model from the given class name.
@return string | resolveModelFromClassName | php | flugg/laravel-responder | src/Console/MakeTransformer.php | https://github.com/flugg/laravel-responder/blob/master/src/Console/MakeTransformer.php | MIT |
protected function buildModelReplacements(array $replace)
{
if (! class_exists($modelClass = $this->parseModel($this->option('model')))) {
if ($this->confirm("A {$modelClass} model does not exist. Do you want to generate it?", true)) {
$this->call('make:model', ['name' => $modelClass]);
}
}
return array_merge($replace, [
'DummyFullModelClass' => $modelClass,
'DummyModelClass' => class_basename($modelClass),
'DummyModelVariable' => lcfirst(class_basename($modelClass)),
]);
} | Build the model replacement values.
@param array $replace
@return array | buildModelReplacements | php | flugg/laravel-responder | src/Console/MakeTransformer.php | https://github.com/flugg/laravel-responder/blob/master/src/Console/MakeTransformer.php | MIT |
protected function parseModel($model)
{
if (preg_match('([^A-Za-z0-9_/\\\\])', $model)) {
throw new InvalidArgumentException('Model name contains invalid characters.');
}
$model = trim(str_replace('/', '\\', $model), '\\');
if (! Str::startsWith($model, $rootNamespace = $this->laravel->getNamespace())) {
$model = $rootNamespace . $model;
}
return $model;
} | Get the fully-qualified model class name.
@param string $model
@return string | parseModel | php | flugg/laravel-responder | src/Console/MakeTransformer.php | https://github.com/flugg/laravel-responder/blob/master/src/Console/MakeTransformer.php | MIT |
protected function getOptions()
{
return [
['model', 'm', InputOption::VALUE_OPTIONAL, 'Generate a model transformer.'],
['plain', 'p', InputOption::VALUE_NONE, 'Generate a plain transformer.'],
];
} | Get the console command options.
@return array | getOptions | php | flugg/laravel-responder | src/Console/MakeTransformer.php | https://github.com/flugg/laravel-responder/blob/master/src/Console/MakeTransformer.php | MIT |
public static function containerResolver(Closure $resolver)
{
static::$containerResolver = $resolver;
} | Set a container using a resolver callback.
@param \Closure $resolver
@return void | containerResolver | php | flugg/laravel-responder | src/Transformers/Transformer.php | https://github.com/flugg/laravel-responder/blob/master/src/Transformers/Transformer.php | MIT |
protected function resolveTransformer(string $transformer)
{
$transformerResolver = $this->resolveContainer()->make(TransformerResolver::class);
return $transformerResolver->resolve($transformer);
} | Resolve a transformer from a class name string.
@param string $transformer
@return mixed | resolveTransformer | php | flugg/laravel-responder | src/Transformers/Transformer.php | https://github.com/flugg/laravel-responder/blob/master/src/Transformers/Transformer.php | MIT |
public function bind($transformable, $transformer = null)
{
$this->bindings = array_merge($this->bindings, is_array($transformable) ? $transformable : [
$transformable => $transformer,
]);
} | Register a transformable to transformer binding.
@param string|array $transformable
@param string|callback|null $transformer
@return void | bind | php | flugg/laravel-responder | src/Transformers/TransformerResolver.php | https://github.com/flugg/laravel-responder/blob/master/src/Transformers/TransformerResolver.php | MIT |
public function resolveFromData($data)
{
$transformer = $this->resolveTransformer($this->resolveTransformableItem($data));
return $this->resolve($transformer);
} | Resolve a transformer from the given data.
@param mixed $data
@return \Flugg\Responder\Transformers\Transformer|callable | resolveFromData | php | flugg/laravel-responder | src/Transformers/TransformerResolver.php | https://github.com/flugg/laravel-responder/blob/master/src/Transformers/TransformerResolver.php | MIT |
protected function resolveTransformer($transformable)
{
if (is_object($transformable) && key_exists(get_class($transformable), $this->bindings)) {
return $this->bindings[get_class($transformable)];
}
if ($transformable instanceof Transformable) {
return $transformable->transformer();
}
return $this->resolve($this->fallback);
} | Resolve a transformer from the transformable element.
@param mixed $transformable
@return \Flugg\Responder\Contracts\Transformable|callable | resolveTransformer | php | flugg/laravel-responder | src/Transformers/TransformerResolver.php | https://github.com/flugg/laravel-responder/blob/master/src/Transformers/TransformerResolver.php | MIT |
protected function resolveTransformableItem($data)
{
if (is_array($data) || $data instanceof Traversable) {
foreach ($data as $item) {
return $item;
}
}
return $data;
} | Resolve a transformable item from the given data.
@param mixed $data
@return mixed | resolveTransformableItem | php | flugg/laravel-responder | src/Transformers/TransformerResolver.php | https://github.com/flugg/laravel-responder/blob/master/src/Transformers/TransformerResolver.php | MIT |
protected function resolveRelation(Model $model, string $identifier)
{
if(config('responder.use_camel_case_relations')) {
$identifier = Str::camel($identifier);
}
$relation = $model->$identifier;
if (method_exists($this, $method = 'filter' . ucfirst($identifier))) {
return $this->$method($relation);
}
return $relation;
} | Resolve a relation from a model instance and an identifier.
@param \Illuminate\Database\Eloquent\Model $model
@param string $identifier
@return mixed | resolveRelation | php | flugg/laravel-responder | src/Transformers/Concerns/HasRelationships.php | https://github.com/flugg/laravel-responder/blob/master/src/Transformers/Concerns/HasRelationships.php | MIT |
protected function mappedTransformerClass(string $identifier)
{
return $this->availableRelations()[$identifier] ?? null;
} | Get a related transformer class mapped to a relation identifier.
@param string $identifier
@return string|null | mappedTransformerClass | php | flugg/laravel-responder | src/Transformers/Concerns/HasRelationships.php | https://github.com/flugg/laravel-responder/blob/master/src/Transformers/Concerns/HasRelationships.php | MIT |
protected function callIncludeMethod(Scope $scope, $identifier, $data)
{
$parameters = iterator_to_array($scope->getManager()->getIncludeParams($scope->getIdentifier($identifier)));
return $this->includeResource($identifier, $data, $parameters);
} | Overrides Fractal's method for including a relation.
@param \League\Fractal\Scope $scope
@param string $identifier
@param mixed $data
@return \League\Fractal\Resource\ResourceInterface | callIncludeMethod | php | flugg/laravel-responder | src/Transformers/Concerns/OverridesFractal.php | https://github.com/flugg/laravel-responder/blob/master/src/Transformers/Concerns/OverridesFractal.php | MIT |
public function bind($transformable, string $resourceKey)
{
$this->bindings = array_merge($this->bindings, is_array($transformable) ? $transformable : [
$transformable => $resourceKey,
]);
} | Register a transformable to resource key binding.
@param string|array $transformable
@param string $resourceKey
@return void | bind | php | flugg/laravel-responder | src/Resources/ResourceKeyResolver.php | https://github.com/flugg/laravel-responder/blob/master/src/Resources/ResourceKeyResolver.php | MIT |
public function resolve($data)
{
$transformable = $this->resolveTransformableItem($data);
if (is_object($transformable) && key_exists(get_class($transformable), $this->bindings)) {
return $this->bindings[get_class($transformable)];
}
if ($transformable instanceof Model) {
return $this->resolveFromModel($transformable);
}
return 'data';
} | Resolve a resource key from the given data.
@param mixed $data
@return string | resolve | php | flugg/laravel-responder | src/Resources/ResourceKeyResolver.php | https://github.com/flugg/laravel-responder/blob/master/src/Resources/ResourceKeyResolver.php | MIT |
public function resolveFromModel(Model $model)
{
if (method_exists($model, 'getResourceKey')) {
return $model->getResourceKey();
}
return $model->getTable();
} | Resolve a resource key from the given model.
@param \Illuminate\Database\Eloquent\Model $model
@return string | resolveFromModel | php | flugg/laravel-responder | src/Resources/ResourceKeyResolver.php | https://github.com/flugg/laravel-responder/blob/master/src/Resources/ResourceKeyResolver.php | MIT |
protected function resolveTransformableItem($data)
{
if (is_array($data) || $data instanceof Traversable) {
foreach ($data as $item) {
return $item;
}
}
return $data;
} | Resolve a transformable item from the given data.
@param mixed $data
@return mixed | resolveTransformableItem | php | flugg/laravel-responder | src/Resources/ResourceKeyResolver.php | https://github.com/flugg/laravel-responder/blob/master/src/Resources/ResourceKeyResolver.php | MIT |
private function runTestMigrations()
{
$schema = $this->app['db']->connection()->getSchemaBuilder();
if (! $schema->hasTable('products')) {
$schema->create('products', function (Blueprint $table) {
$table->increments('id');
$table->string('name')->nullable();
$table->timestamps();
});
}
if (! $schema->hasTable('shipments')) {
$schema->create('shipments', function (Blueprint $table) {
$table->increments('id');
$table->unsignedInteger('product_id');
$table->timestamps();
});
}
if (! $schema->hasTable('orders')) {
$schema->create('orders', function (Blueprint $table) {
$table->increments('id');
$table->unsignedInteger('product_id');
$table->unsignedInteger('customer_id');
$table->timestamps();
});
}
if (! $schema->hasTable('customers')) {
$schema->create('customers', function (Blueprint $table) {
$table->increments('id');
$table->string('name')->nullable();
$table->timestamps();
});
}
} | Run migrations for tables used for testing purposes.
@return void | runTestMigrations | php | flugg/laravel-responder | tests/TestCase.php | https://github.com/flugg/laravel-responder/blob/master/tests/TestCase.php | MIT |
protected function getPackageProviders($app)
{
return [
ResponderServiceProvider::class,
];
} | Get package service providers.
@param \Illuminate\Foundation\Application $app
@return array | getPackageProviders | php | flugg/laravel-responder | tests/TestCase.php | https://github.com/flugg/laravel-responder/blob/master/tests/TestCase.php | MIT |
public function __construct(AbstractBrowser $client, ?string $baseUrl = null)
{
$this->client = $client;
$this->client->followRedirects(true);
if ($baseUrl !== null && $client instanceof HttpKernelBrowser) {
$basePath = parse_url($baseUrl, PHP_URL_PATH);
if (\is_string($basePath)) {
$client->setServerParameter('SCRIPT_FILENAME', $basePath);
}
}
} | Initializes BrowserKit driver.
@param AbstractBrowser<TRequest, TResponse> $client
@param string|null $baseUrl Base URL for HttpKernel clients | __construct | php | minkphp/MinkBrowserKitDriver | src/BrowserKitDriver.php | https://github.com/minkphp/MinkBrowserKitDriver/blob/master/src/BrowserKitDriver.php | MIT |
public function getClient()
{
return $this->client;
} | Returns BrowserKit browser instance.
@return AbstractBrowser<TRequest, TResponse> | getClient | php | minkphp/MinkBrowserKitDriver | src/BrowserKitDriver.php | https://github.com/minkphp/MinkBrowserKitDriver/blob/master/src/BrowserKitDriver.php | MIT |
protected function prepareUrl(string $url)
{
return $url;
} | Prepares URL for visiting.
Removes "*.php/" from urls and then passes it to BrowserKitDriver::visit().
@param string $url
@return string | prepareUrl | php | minkphp/MinkBrowserKitDriver | src/BrowserKitDriver.php | https://github.com/minkphp/MinkBrowserKitDriver/blob/master/src/BrowserKitDriver.php | MIT |
protected function getFormField(string $xpath)
{
$fieldNode = $this->getCrawlerNode($this->getFilteredCrawler($xpath));
$fieldType = $fieldNode->getAttribute('type');
if (\in_array($fieldType, ['button', 'submit', 'image'], true)) {
throw new DriverException(sprintf('Cannot access a form field of type "%s".', $fieldType));
}
$fieldName = str_replace('[]', '', $fieldNode->getAttribute('name'));
$formNode = $this->getFormNode($fieldNode);
$formId = $this->getFormNodeId($formNode);
if (!isset($this->forms[$formId])) {
$this->forms[$formId] = new Form($formNode, $this->getCurrentUrl());
}
if (is_array($this->forms[$formId][$fieldName])) {
$positionField = $this->forms[$formId][$fieldName][$this->getFieldPosition($fieldNode)];
\assert($positionField instanceof FormField);
return $positionField;
}
return $this->forms[$formId][$fieldName];
} | Returns form field from XPath query.
@param string $xpath
@return FormField
@throws DriverException
@throws \InvalidArgumentException when the field does not exist in the BrowserKit form | getFormField | php | minkphp/MinkBrowserKitDriver | src/BrowserKitDriver.php | https://github.com/minkphp/MinkBrowserKitDriver/blob/master/src/BrowserKitDriver.php | MIT |
public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
{
parent::__construct($message, $code, $previous);
} | DEPRECATION WARNING! This class will be removed in the next major point release.
@deprecated since version 9.7.0 | __construct | php | thephpleague/csv | src/SyntaxError.php | https://github.com/thephpleague/csv/blob/master/src/SyntaxError.php | MIT |
public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
{
parent::__construct($message, $code, $previous);
} | DEPRECATION WARNING! This class will be removed in the next major point release.
@deprecated since version 9.7.0 | __construct | php | thephpleague/csv | src/UnavailableFeature.php | https://github.com/thephpleague/csv/blob/master/src/UnavailableFeature.php | MIT |
public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
{
parent::__construct($message, $code, $previous);
} | DEPRECATION WARNING! This class will be removed in the next major point release.
@deprecated since version 9.7.0 | __construct | php | thephpleague/csv | src/InvalidArgument.php | https://github.com/thephpleague/csv/blob/master/src/InvalidArgument.php | MIT |
public function getSocket()
{
return $this->socket;
} | Return socket resource if is exist
@return resource | getSocket | php | EvilFreelancer/routeros-api-php | src/SocketTrait.php | https://github.com/EvilFreelancer/routeros-api-php/blob/master/src/SocketTrait.php | MIT |
public function key()
{
return $this->current;
} | Return the key of the current element
@return mixed | key | php | EvilFreelancer/routeros-api-php | src/ResponseIterator.php | https://github.com/EvilFreelancer/routeros-api-php/blob/master/src/ResponseIterator.php | MIT |
private function config(string $parameter)
{
return $this->config->get($parameter);
} | Get some parameter from config
@param string $parameter Name of required parameter
@return mixed
@throws \RouterOS\Exceptions\ConfigException | config | php | EvilFreelancer/routeros-api-php | src/Client.php | https://github.com/EvilFreelancer/routeros-api-php/blob/master/src/Client.php | MIT |
public function readRAW(array $options = [])
{
// By default response is empty
$response = [];
// We have to wait a !done or !fatal
$lastReply = false;
// Count !re in response
$countResponse = 0;
// Convert strings to array and return results
if ($this->isCustomOutput()) {
// Return RAW configuration
return $this->customOutput;
}
// Read answer from socket in loop, or until timeout reached
$startTime = time();
while (true) {
// Exit from loop if timeout reached
if (time() > $startTime + $this->config('socket_timeout')) {
throw new ClientException('Socket timeout reached');
}
$word = $this->connector->readWord();
//Limit response number to finish the read
if (isset($options['count']) && $countResponse >= (int) $options['count']) {
$lastReply = true;
}
if ('' === $word) {
if ($lastReply) {
// We received a !done or !fatal message in a precedent loop
// response is complete
break;
}
// We did not receive the !done or !fatal message
// This 0 length message is the end of a reply !re or !trap
// We have to wait the router to send a !done or !fatal reply followed by optionals values and a 0 length message
continue;
}
// Save output line to response array
$response[] = $word;
// If we get a !done or !fatal line in response, we are now ready to finish the read
// but we need to wait a 0 length message, switch the flag
if ('!done' === $word || '!fatal' === $word) {
$lastReply = true;
}
// If we get a !re line in response, we increment the variable
if ('!re' === $word) {
$countResponse++;
}
}
// Parse results and return
return $response;
} | Read RAW response from RouterOS, it can be /export command results also, not only array from API
@param array $options Additional options
@return array|string
@since 1.0.0 | readRAW | php | EvilFreelancer/routeros-api-php | src/Client.php | https://github.com/EvilFreelancer/routeros-api-php/blob/master/src/Client.php | MIT |
public function read(bool $parse = true, array $options = [])
{
// Read RAW response
$response = $this->readRAW($options);
// Return RAW configuration if custom output is set
if ($this->isCustomOutput()) {
$this->customOutput = null;
return $response;
}
// Parse results and return
return $parse ? $this->rosario($response) : $response;
} | Read answer from server after query was executed
A Mikrotik reply is formed of blocks
Each block starts with a word, one of ('!re', '!trap', '!done', '!fatal')
Each block end with an zero byte (empty line)
Reply ends with a complete !done or !fatal block (ended with 'empty line')
A !fatal block precedes TCP connexion close
@param bool $parse If need parse output to array
@param array $options Additional options
@return mixed | read | php | EvilFreelancer/routeros-api-php | src/Client.php | https://github.com/EvilFreelancer/routeros-api-php/blob/master/src/Client.php | MIT |
public static function checkIfKeysNotExist(array $keys, array $array)
{
$output = [];
foreach ($keys as $key) {
if (self::checkIfKeyNotExist($key, $array)) {
$output[] = $key;
}
}
return !empty($output) ? implode(',', $output) : true;
} | Check if required keys in array of parameters
@param array $keys
@param array $array
@return array|bool Return true if all fine, and string with name of key which was not found | checkIfKeysNotExist | php | EvilFreelancer/routeros-api-php | src/Helpers/ArrayHelper.php | https://github.com/EvilFreelancer/routeros-api-php/blob/master/src/Helpers/ArrayHelper.php | MIT |
public function boot()
{
$this->loadViewsFrom(__DIR__.'/Templates', 'invoices');
$this->publishes([
__DIR__.'/Templates' => resource_path('views/vendor/invoices'),
__DIR__.'/Config/invoices.php' => config_path('invoices.php'),
], 'invoices');
} | Bootstrap any application services.
@return void | boot | php | ConsoleTVs/Invoices | InvoicesServiceProvider.php | https://github.com/ConsoleTVs/Invoices/blob/master/InvoicesServiceProvider.php | MIT |
public function register()
{
$this->mergeConfigFrom(
__DIR__.'/Config/invoices.php', 'invoices'
);
} | Register any application services.
@return void | register | php | ConsoleTVs/Invoices | InvoicesServiceProvider.php | https://github.com/ConsoleTVs/Invoices/blob/master/InvoicesServiceProvider.php | MIT |
public function decimals($decimals)
{
$this->decimals = $decimals;
return $this;
} | Set the invoice decimal precision.
@method decimals
@param int $decimals
@return self | decimals | php | ConsoleTVs/Invoices | Traits/Setters.php | https://github.com/ConsoleTVs/Invoices/blob/master/Traits/Setters.php | MIT |
public function business($details)
{
$this->business_details = Collection::make($details);
return $this;
} | Set the invoice business details.
@method business
@param array $details
@return self | business | php | ConsoleTVs/Invoices | Traits/Setters.php | https://github.com/ConsoleTVs/Invoices/blob/master/Traits/Setters.php | MIT |
public function customer($details)
{
$this->customer_details = Collection::make($details);
return $this;
} | Set the invoice customer details.
@method customer
@param array $details
@return self | customer | php | ConsoleTVs/Invoices | Traits/Setters.php | https://github.com/ConsoleTVs/Invoices/blob/master/Traits/Setters.php | MIT |
public function with_pagination($with_pagination)
{
$this->with_pagination = $with_pagination;
return $this;
} | Show/hide the invoice pagination.
@method with_pagination
@param boolean $with_pagination
@return self | with_pagination | php | ConsoleTVs/Invoices | Traits/Setters.php | https://github.com/ConsoleTVs/Invoices/blob/master/Traits/Setters.php | MIT |
public function duplicate_header($duplicate_header)
{
$this->duplicate_header = $duplicate_header;
return $this;
} | Duplicate the header on each page.
@method duplicate_header
@param boolean $duplicate_header
@return self | duplicate_header | php | ConsoleTVs/Invoices | Traits/Setters.php | https://github.com/ConsoleTVs/Invoices/blob/master/Traits/Setters.php | MIT |
public function __construct($name = 'Invoice')
{
$this->name = $name;
$this->template = 'default';
$this->items = Collection::make([]);
$this->currency = config('invoices.currency');
$this->decimals = config('invoices.decimals');
$this->logo = config('invoices.logo');
$this->logo_height = config('invoices.logo_height');
$this->date = Carbon::now();
$this->business_details = Collection::make(config('invoices.business_details'));
$this->customer_details = Collection::make([]);
$this->footnote = config('invoices.footnote');
$this->tax_rates = config('invoices.tax_rates');
$this->due_date = config('invoices.due_date') != null ? Carbon::parse(config('invoices.due_date')) : null;
$this->with_pagination = config('invoices.with_pagination');
$this->duplicate_header = config('invoices.duplicate_header');
} | Create a new invoice instance.
@method __construct
@param string $name | __construct | php | ConsoleTVs/Invoices | Classes/Invoice.php | https://github.com/ConsoleTVs/Invoices/blob/master/Classes/Invoice.php | MIT |
public static function make($name = 'Invoice')
{
return new self($name);
} | Return a new instance of Invoice.
@method make
@param string $name
@return ConsoleTVs\Invoices\Classes\Invoice | make | php | ConsoleTVs/Invoices | Classes/Invoice.php | https://github.com/ConsoleTVs/Invoices/blob/master/Classes/Invoice.php | MIT |
private function subTotalPrice()
{
return $this->items->sum(function ($item) {
return bcmul($item['price'], $item['ammount'], $this->decimals);
});
} | Return the subtotal invoice price.
@method subTotalPrice
@return int | subTotalPrice | php | ConsoleTVs/Invoices | Classes/Invoice.php | https://github.com/ConsoleTVs/Invoices/blob/master/Classes/Invoice.php | MIT |
public function subTotalPriceFormatted()
{
return number_format($this->subTotalPrice(), $this->decimals);
} | Return formatted sub total price.
@method subTotalPriceFormatted
@return int | subTotalPriceFormatted | php | ConsoleTVs/Invoices | Classes/Invoice.php | https://github.com/ConsoleTVs/Invoices/blob/master/Classes/Invoice.php | MIT |
private function totalPrice()
{
return bcadd($this->subTotalPrice(), $this->taxPrice(), $this->decimals);
} | Return the total invoce price after aplying the tax.
@method totalPrice
@return int | totalPrice | php | ConsoleTVs/Invoices | Classes/Invoice.php | https://github.com/ConsoleTVs/Invoices/blob/master/Classes/Invoice.php | MIT |
public function shouldDisplayImageColumn()
{
foreach($this->items as $item){
if($item['imageUrl'] != null){
return true;
}
}
} | Return true/false if one item contains image.
Determine if we should display or not the image column on the invoice.
@method shouldDisplayImageColumn
@return boolean | shouldDisplayImageColumn | php | ConsoleTVs/Invoices | Classes/Invoice.php | https://github.com/ConsoleTVs/Invoices/blob/master/Classes/Invoice.php | MIT |
protected function resolveUserIdFromConfig($userIdResolver)
{
if (is_array($userIdResolver) && count($userIdResolver) === 2) {
// Assuming the configuration is in the format [ClassName::class, 'methodName']
[$class, $method] = $userIdResolver;
return app($class)->$method();
}
// Default to authenticated user's ID if the configuration is not a valid callable
return auth()->check() ? auth()->user()->id : 'global';
} | Resolve the user ID from a config value if it's not a closure.
@param mixed $userIdResolver
@return mixed | resolveUserIdFromConfig | php | square1-io/laravel-idempotency | src/Http/Middleware/IdempotencyMiddleware.php | https://github.com/square1-io/laravel-idempotency/blob/master/src/Http/Middleware/IdempotencyMiddleware.php | MIT |
protected function validateConfig()
{
$behaviour = config('idempotency.on_duplicate_behaviour');
try {
// This will throw a ValueError if the behavior is not valid
DuplicateBehaviour::from($behaviour);
} catch (\ValueError $e) {
$validOptions = implode(', ', array_column(DuplicateBehaviour::cases(), 'value'));
throw new InvalidConfigurationException(
"Invalid idempotency duplicate behavior: '{$behaviour}'. Valid options are: {$validOptions}"
);
}
// You can add similar validation for other config values if needed
$enforced_verbs = config('idempotency.enforced_verbs', []);
$valid_verbs = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS'];
foreach ($enforced_verbs as $verb) {
if (! in_array(strtoupper($verb), $valid_verbs)) {
throw new InvalidConfigurationException(
"Invalid HTTP verb in enforced_verbs: '{$verb}'. Valid verbs are: ".
implode(', ', $valid_verbs)
);
}
}
} | Validate that the configuration values are valid
@throws InvalidConfigurationException | validateConfig | php | square1-io/laravel-idempotency | src/Http/Middleware/IdempotencyMiddleware.php | https://github.com/square1-io/laravel-idempotency/blob/master/src/Http/Middleware/IdempotencyMiddleware.php | MIT |
public function __construct(string $path, array $defaults = [], array $requirements = [], array $options = [], ?string $host = '', string|array $schemes = [], string|array $methods = [], ?string $condition = '')
{
$this->setPath($path);
$this->addDefaults($defaults);
$this->addRequirements($requirements);
$this->setOptions($options);
$this->setHost($host);
$this->setSchemes($schemes);
$this->setMethods($methods);
$this->setCondition($condition);
} | Constructor.
Available options:
* compiler_class: A class name able to compile this route instance (RouteCompiler by default)
* utf8: Whether UTF-8 matching is enforced ot not
@param string $path The path pattern to match
@param array $defaults An array of default parameter values
@param array<string|\Stringable> $requirements An array of requirements for parameters (regexes)
@param array $options An array of options
@param string|null $host The host pattern to match
@param string|string[] $schemes A required URI scheme or an array of restricted schemes
@param string|string[] $methods A required HTTP method or an array of restricted methods
@param string|null $condition A condition that should evaluate to true for the route to match | __construct | php | symfony/routing | Route.php | https://github.com/symfony/routing/blob/master/Route.php | MIT |
public function IsSMTP() {
$this->Mailer = 'smtp';
} | Sets Mailer to send message using SMTP.
@return void | IsSMTP | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function IsMail() {
$this->Mailer = 'mail';
} | Sets Mailer to send message using PHP mail() function.
@return void | IsMail | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function IsSendmail() {
if (!stristr(ini_get('sendmail_path'), 'sendmail')) {
$this->Sendmail = '/var/qmail/bin/sendmail';
}
$this->Mailer = 'sendmail';
} | Sets Mailer to send message using the $Sendmail program.
@return void | IsSendmail | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function IsQmail() {
if (stristr(ini_get('sendmail_path'), 'qmail')) {
$this->Sendmail = '/var/qmail/bin/sendmail';
}
$this->Mailer = 'sendmail';
} | Sets Mailer to send message using the qmail MTA.
@return void | IsQmail | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function AddCC($address, $name = '') {
return $this->AddAnAddress('cc', $address, $name);
} | Adds a "Cc" address.
Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
@param string $address
@param string $name
@return boolean true on success, false if address already used | AddCC | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function AddBCC($address, $name = '') {
return $this->AddAnAddress('bcc', $address, $name);
} | Adds a "Bcc" address.
Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
@param string $address
@param string $name
@return boolean true on success, false if address already used | AddBCC | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
private function AddAnAddress($kind, $address, $name = '') {
if (!preg_match('/^(to|cc|bcc|ReplyTo)$/', $kind)) {
echo 'Invalid recipient array: ' . kind;
return false;
}
$address = trim($address);
$name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim
if (!self::ValidateAddress($address)) {
$this->SetError($this->Lang('invalid_address') . ': ' . $address);
if ($this->exceptions) {
throw new tpure_PHPMailerException($this->Lang('invalid_address') . ': ' . $address);
}
echo $this->Lang('invalid_address') . ': ' . $address;
return false;
}
if ($kind != 'ReplyTo') {
if (!isset($this->all_recipients[strtolower($address)])) {
array_push($this->$kind, array($address, $name));
$this->all_recipients[strtolower($address)] = true;
return true;
}
} else {
if (!array_key_exists(strtolower($address), $this->ReplyTo)) {
$this->ReplyTo[strtolower($address)] = array($address, $name);
return true;
}
}
return false;
} | Adds an address to one of the recipient arrays
Addresses that have been added already return false, but do not throw exceptions
@param string $kind One of 'to', 'cc', 'bcc', 'ReplyTo'
@param string $address The email address to send to
@param string $name
@return boolean true on success, false if address already used or invalid in some way
@access private | AddAnAddress | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function SetFrom($address, $name = '', $auto = 1) {
$address = trim($address);
$name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim
if (!self::ValidateAddress($address)) {
$this->SetError($this->Lang('invalid_address') . ': ' . $address);
if ($this->exceptions) {
throw new tpure_PHPMailerException($this->Lang('invalid_address') . ': ' . $address);
}
echo $this->Lang('invalid_address') . ': ' . $address;
return false;
}
$this->From = $address;
$this->FromName = $name;
if ($auto) {
if (empty($this->ReplyTo)) {
$this->AddAnAddress('ReplyTo', $address, $name);
}
if (empty($this->Sender)) {
$this->Sender = $address;
}
}
return true;
} | Set the From and FromName properties
@param string $address
@param string $name
@return boolean | SetFrom | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public static function ValidateAddress($address) {
if (function_exists('filter_var')) {
//Introduced in PHP 5.2
if (filter_var($address, FILTER_VALIDATE_EMAIL) === FALSE) {
return false;
} else {
return true;
}
} else {
return preg_match('/^(?:[\w\!\#\$\%\&\'\*\+\-\/\=\?\^\`\{\|\}\~]+\.)*[\w\!\#\$\%\&\'\*\+\-\/\=\?\^\`\{\|\}\~]+@(?:(?:(?:[a-zA-Z0-9_](?:[a-zA-Z0-9_\-](?!\.)){0,61}[a-zA-Z0-9_-]?\.)+[a-zA-Z0-9_](?:[a-zA-Z0-9_\-](?!$)){0,61}[a-zA-Z0-9_]?)|(?:\[(?:(?:[01]?\d{1,2}|2[0-4]\d|25[0-5])\.){3}(?:[01]?\d{1,2}|2[0-4]\d|25[0-5])\]))$/', $address);
}
} | Check that a string looks roughly like an email address should
Static so it can be used without instantiation
Tries to use PHP built-in validator in the filter extension (from PHP 5.2), falls back to a reasonably competent regex validator
Conforms approximately to RFC2822
@link http://www.hexillion.com/samples/#Regex Original pattern found here
@param string $address The email address to check
@return boolean
@static
@access public | ValidateAddress | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function Send() {
try {
if ((count($this->to) + count($this->cc) + count($this->bcc)) < 1) {
throw new tpure_PHPMailerException($this->Lang('provide_address'), self::STOP_CRITICAL);
}
// Set whether the message is multipart/alternative
if (!empty($this->AltBody)) {
$this->ContentType = 'multipart/alternative';
}
$this->error_count = 0; // reset errors
$this->SetMessageType();
$header = $this->CreateHeader();
$body = $this->CreateBody();
if (empty($this->Body)) {
throw new tpure_PHPMailerException($this->Lang('empty_message'), self::STOP_CRITICAL);
}
// digitally sign with DKIM if enabled
if ($this->DKIM_domain && $this->DKIM_private) {
$header_dkim = $this->DKIM_Add($header, $this->Subject, $body);
$header = str_replace("\r\n", "\n", $header_dkim) . $header;
}
// Choose the mailer and send through it
switch ($this->Mailer) {
case 'sendmail':
return $this->SendmailSend($header, $body);
case 'smtp':
return $this->SmtpSend($header, $body);
default:
return $this->MailSend($header, $body);
}
} catch (tpure_PHPMailerException $e) {
$this->SetError($e->getMessage());
if ($this->exceptions) {
throw $e;
}
echo $e->getMessage() . "\n";
return false;
}
} | Creates message and assigns Mailer. If the message is
not sent successfully then it returns false. Use the ErrorInfo
variable to view description of the error.
@return bool | Send | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
protected function SmtpSend($header, $body) {
require_once $this->PluginDir . 'smtp.php';
$bad_rcpt = array();
if (!$this->SmtpConnect()) {
throw new tpure_PHPMailerException($this->Lang('smtp_connect_failed'), self::STOP_CRITICAL);
}
$smtp_from = ($this->Sender == '') ? $this->From : $this->Sender;
if (!$this->smtp->Mail($smtp_from)) {
throw new tpure_PHPMailerException($this->Lang('from_failed') . $smtp_from, self::STOP_CRITICAL);
}
// Attempt to send attach all recipients
foreach ($this->to as $to) {
if (!$this->smtp->Recipient($to[0])) {
$bad_rcpt[] = $to[0];
// implement call back function if it exists
$isSent = 0;
$this->doCallback($isSent, $to[0], '', '', $this->Subject, $body);
} else {
// implement call back function if it exists
$isSent = 1;
$this->doCallback($isSent, $to[0], '', '', $this->Subject, $body);
}
}
foreach ($this->cc as $cc) {
if (!$this->smtp->Recipient($cc[0])) {
$bad_rcpt[] = $cc[0];
// implement call back function if it exists
$isSent = 0;
$this->doCallback($isSent, '', $cc[0], '', $this->Subject, $body);
} else {
// implement call back function if it exists
$isSent = 1;
$this->doCallback($isSent, '', $cc[0], '', $this->Subject, $body);
}
}
foreach ($this->bcc as $bcc) {
if (!$this->smtp->Recipient($bcc[0])) {
$bad_rcpt[] = $bcc[0];
// implement call back function if it exists
$isSent = 0;
$this->doCallback($isSent, '', '', $bcc[0], $this->Subject, $body);
} else {
// implement call back function if it exists
$isSent = 1;
$this->doCallback($isSent, '', '', $bcc[0], $this->Subject, $body);
}
}
if (count($bad_rcpt) > 0) {
//Create error message for any bad addresses
$badaddresses = implode(', ', $bad_rcpt);
throw new tpure_PHPMailerException($this->Lang('recipients_failed') . $badaddresses);
}
if (!$this->smtp->Data($header . $body)) {
throw new tpure_PHPMailerException($this->Lang('data_not_accepted'), self::STOP_CRITICAL);
}
if ($this->SMTPKeepAlive == true) {
$this->smtp->Reset();
}
return true;
} | Sends mail via SMTP using PhpSMTP
Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
@param string $header The message headers
@param string $body The message body
@uses SMTP
@access protected
@return bool | SmtpSend | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function SmtpConnect() {
if (is_null($this->smtp)) {
$this->smtp = new tpure_SMTP();
}
$this->smtp->do_debug = $this->SMTPDebug;
$hosts = explode(';', $this->Host);
$index = 0;
$connection = $this->smtp->Connected();
// Retry while there is no connection
try {
while ($index < count($hosts) && !$connection) {
$hostinfo = array();
if (preg_match('/^(.+):([0-9]+)$/', $hosts[$index], $hostinfo)) {
$host = $hostinfo[1];
$port = $hostinfo[2];
} else {
$host = $hosts[$index];
$port = $this->Port;
}
$tls = ($this->SMTPSecure == 'tls');
$ssl = ($this->SMTPSecure == 'ssl');
if ($this->smtp->Connect(($ssl ? 'ssl://' : '') . $host, $port, $this->Timeout)) {
$hello = ($this->Helo != '' ? $this->Helo : $this->ServerHostname());
$this->smtp->Hello($hello);
if ($tls) {
if (!$this->smtp->StartTLS()) {
throw new tpure_PHPMailerException($this->Lang('tls'));
}
//We must resend HELO after tls negotiation
$this->smtp->Hello($hello);
}
$connection = true;
if ($this->SMTPAuth) {
if (!$this->smtp->Authenticate($this->Username, $this->Password)) {
throw new tpure_PHPMailerException($this->Lang('authenticate'));
}
}
}
$index++;
if (!$connection) {
throw new tpure_PHPMailerException($this->Lang('connect_host'));
}
}
} catch (tpure_PHPMailerException $e) {
$this->smtp->Reset();
throw $e;
}
return true;
} | Initiates a connection to an SMTP server.
Returns false if the operation failed.
@uses SMTP
@access public
@return bool | SmtpConnect | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function SmtpClose() {
if (!is_null($this->smtp)) {
if ($this->smtp->Connected()) {
$this->smtp->Quit();
$this->smtp->Close();
}
}
} | Closes the active SMTP session if one exists.
@return void | SmtpClose | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
function SetLanguage($langcode = 'en', $lang_path = 'language/') {
//Define full set of translatable strings
$PHPMAILER_LANG = array(
'provide_address' => '请在邮件通知中设置收信邮箱地址.',
'mailer_not_supported' => ' 不支持的邮件程序.',
'execute' => 'Could not execute: ',
'instantiate' => 'Could not instantiate mail function.',
'authenticate' => '发信邮箱账号或 密码/授权码 错误.',
'from_failed' => 'The following From address failed: ',
'recipients_failed' => 'SMTP Error: The following recipients failed: ',
'data_not_accepted' => 'SMTP Error: Data not accepted.',
'connect_host' => 'SMTP Error: Could not connect to SMTP host.',
'file_access' => 'Could not access file: ',
'file_open' => 'File Error: Could not open file: ',
'encoding' => 'Unknown encoding: ',
'signing' => 'Signing Error: ',
'smtp_error' => 'SMTP server error: ',
'empty_message' => 'Message body empty',
'invalid_address' => '地址无效',
'variable_set' => 'Cannot set or reset variable: ',
);
//Overwrite language-specific strings. This way we'll never have missing translations - no more "language string failed to load"!
$l = true;
if ($langcode != 'en') {
//There is no English translation file
$l = @include $lang_path . 'phpmailer.lang-' . $langcode . '.php';
}
$this->language = $PHPMAILER_LANG;
return ($l == true); //Returns false if language not found
} | Sets the language for all class error messages.
Returns false if it cannot load the language file. The default language is English.
@param string $langcode ISO 639-1 2-character language code (e.g. Portuguese: "br")
@param string $lang_path Path to the language file directory
@access public | SetLanguage | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function GetTranslations() {
return $this->language;
} | Return the current array of language strings
@return array | GetTranslations | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function WrapText($message, $length, $qp_mode = false) {
$soft_break = ($qp_mode) ? sprintf(" =%s", $this->LE) : $this->LE;
// If utf-8 encoding is used, we will need to make sure we don't
// split multibyte characters when we wrap
$is_utf8 = (strtolower($this->CharSet) == "utf-8");
$message = $this->FixEOL($message);
if (substr($message, -1) == $this->LE) {
$message = substr($message, 0, -1);
}
$line = explode($this->LE, $message);
$message = '';
for ($i = 0; $i < count($line); $i++) {
$line_part = explode(' ', $line[$i]);
$buf = '';
for ($e = 0; $e < count($line_part); $e++) {
$word = $line_part[$e];
if ($qp_mode and (strlen($word) > $length)) {
$space_left = $length - strlen($buf) - 1;
if ($e != 0) {
if ($space_left > 20) {
$len = $space_left;
if ($is_utf8) {
$len = $this->UTF8CharBoundary($word, $len);
} elseif (substr($word, $len - 1, 1) == "=") {
$len--;
} elseif (substr($word, $len - 2, 1) == "=") {
$len -= 2;
}
$part = substr($word, 0, $len);
$word = substr($word, $len);
$buf .= ' ' . $part;
$message .= $buf . sprintf("=%s", $this->LE);
} else {
$message .= $buf . $soft_break;
}
$buf = '';
}
while (strlen($word) > 0) {
$len = $length;
if ($is_utf8) {
$len = $this->UTF8CharBoundary($word, $len);
} elseif (substr($word, $len - 1, 1) == "=") {
$len--;
} elseif (substr($word, $len - 2, 1) == "=") {
$len -= 2;
}
$part = substr($word, 0, $len);
$word = substr($word, $len);
if (strlen($word) > 0) {
$message .= $part . sprintf("=%s", $this->LE);
} else {
$buf = $part;
}
}
} else {
$buf_o = $buf;
$buf .= ($e == 0) ? $word : (' ' . $word);
if (strlen($buf) > $length and $buf_o != '') {
$message .= $buf_o . $soft_break;
$buf = $word;
}
}
}
$message .= $buf . $this->LE;
}
return $message;
} | Wraps message for use with mailers that do not
automatically perform wrapping and for quoted-printable.
Original written by philippe.
@param string $message The message to wrap
@param integer $length The line length to wrap to
@param boolean $qp_mode Whether to run in Quoted-Printable mode
@access public
@return string | WrapText | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function CreateBody() {
$body = '';
if ($this->sign_key_file) {
$body .= $this->GetMailMIME();
}
$this->SetWordWrap();
switch ($this->message_type) {
case 'alt':
$body .= $this->GetBoundary($this->boundary[1], '', 'text/plain', '');
$body .= $this->EncodeString($this->AltBody, $this->Encoding);
$body .= $this->LE . $this->LE;
$body .= $this->GetBoundary($this->boundary[1], '', 'text/html', '');
$body .= $this->EncodeString($this->Body, $this->Encoding);
$body .= $this->LE . $this->LE;
$body .= $this->EndBoundary($this->boundary[1]);
break;
case 'plain':
$body .= $this->EncodeString($this->Body, $this->Encoding);
break;
case 'attachments':
$body .= $this->GetBoundary($this->boundary[1], '', '', '');
$body .= $this->EncodeString($this->Body, $this->Encoding);
$body .= $this->LE;
$body .= $this->AttachAll();
break;
case 'alt_attachments':
$body .= sprintf("--%s%s", $this->boundary[1], $this->LE);
$body .= sprintf("Content-Type: %s;%s" . "\tboundary=\"%s\"%s", 'multipart/alternative', $this->LE, $this->boundary[2], $this->LE . $this->LE);
$body .= $this->GetBoundary($this->boundary[2], '', 'text/plain', '') . $this->LE; // Create text body
$body .= $this->EncodeString($this->AltBody, $this->Encoding);
$body .= $this->LE . $this->LE;
$body .= $this->GetBoundary($this->boundary[2], '', 'text/html', '') . $this->LE; // Create the HTML body
$body .= $this->EncodeString($this->Body, $this->Encoding);
$body .= $this->LE . $this->LE;
$body .= $this->EndBoundary($this->boundary[2]);
$body .= $this->AttachAll();
break;
}
if ($this->IsError()) {
$body = '';
} elseif ($this->sign_key_file) {
try {
$file = tempnam('', 'mail');
file_put_contents($file, $body); //TODO check this worked
$signed = tempnam("", "signed");
if (@openssl_pkcs7_sign($file, $signed, "file://" . $this->sign_cert_file, array("file://" . $this->sign_key_file, $this->sign_key_pass), NULL)) {
@unlink($file);
@unlink($signed);
$body = file_get_contents($signed);
} else {
@unlink($file);
@unlink($signed);
throw new tpure_PHPMailerException($this->Lang("signing") . openssl_error_string());
}
} catch (tpure_PHPMailerException $e) {
$body = '';
if ($this->exceptions) {
throw $e;
}
}
}
return $body;
} | Assembles the message body. Returns an empty string on failure.
@access public
@return string The assembled message body | CreateBody | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
private function GetBoundary($boundary, $charSet, $contentType, $encoding) {
$result = '';
if ($charSet == '') {
$charSet = $this->CharSet;
}
if ($contentType == '') {
$contentType = $this->ContentType;
}
if ($encoding == '') {
$encoding = $this->Encoding;
}
$result .= $this->TextLine('--' . $boundary);
$result .= sprintf("Content-Type: %s; charset = \"%s\"", $contentType, $charSet);
$result .= $this->LE;
$result .= $this->HeaderLine('Content-Transfer-Encoding', $encoding);
$result .= $this->LE;
return $result;
} | Returns the start of a message boundary.
@access private | GetBoundary | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
private function EndBoundary($boundary) {
return $this->LE . '--' . $boundary . '--' . $this->LE;
} | Returns the end of a message boundary.
@access private | EndBoundary | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function HeaderLine($name, $value) {
return $name . ': ' . $value . $this->LE;
} | Returns a formatted header line.
@access public
@return string | HeaderLine | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function TextLine($value) {
return $value . $this->LE;
} | Returns a formatted mail line.
@access public
@return string | TextLine | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function AddAttachment($path, $name = '', $encoding = 'base64', $type = 'application/octet-stream') {
try {
if (!@is_file($path)) {
throw new tpure_PHPMailerException($this->Lang('file_access') . $path, self::STOP_CONTINUE);
}
$filename = basename($path);
if ($name == '') {
$name = $filename;
}
$this->attachment[] = array(
0 => $path,
1 => $filename,
2 => $name,
3 => $encoding,
4 => $type,
5 => false, // isStringAttachment
6 => 'attachment',
7 => 0,
);
} catch (tpure_PHPMailerException $e) {
$this->SetError($e->getMessage());
if ($this->exceptions) {
throw $e;
}
echo $e->getMessage() . "\n";
if ($e->getCode() == self::STOP_CRITICAL) {
return false;
}
}
return true;
} | Adds an attachment from a path on the filesystem.
Returns false if the file could not be found
or accessed.
@param string $path Path to the attachment.
@param string $name Overrides the attachment name.
@param string $encoding File encoding (see $Encoding).
@param string $type File extension (MIME) type.
@return bool | AddAttachment | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function GetAttachments() {
return $this->attachment;
} | Return the current array of attachments
@return array | GetAttachments | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
private function EncodeFile($path, $encoding = 'base64') {
try {
if (!is_readable($path)) {
throw new tpure_PHPMailerException($this->Lang('file_open') . $path, self::STOP_CONTINUE);
}
if (function_exists('get_magic_quotes')) {
function get_magic_quotes() {
return false;
}
}
if (PHP_VERSION < 6) {
$magic_quotes = get_magic_quotes_runtime();
set_magic_quotes_runtime(0);
}
$file_buffer = file_get_contents($path);
$file_buffer = $this->EncodeString($file_buffer, $encoding);
if (PHP_VERSION < 6) {set_magic_quotes_runtime($magic_quotes);}
return $file_buffer;
} catch (Exception $e) {
$this->SetError($e->getMessage());
return '';
}
} | Encodes attachment in requested format.
Returns an empty string on failure.
@param string $path The full path to the file
@param string $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
@see EncodeFile()
@access private
@return string | EncodeFile | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function EncodeString($str, $encoding = 'base64') {
$encoded = '';
switch (strtolower($encoding)) {
case 'base64':
$encoded = chunk_split(base64_encode($str), 76, $this->LE);
break;
case '7bit':
case '8bit':
$encoded = $this->FixEOL($str);
//Make sure it ends with a line break
if (substr($encoded, -(strlen($this->LE))) != $this->LE) {
$encoded .= $this->LE;
}
break;
case 'binary':
$encoded = $str;
break;
case 'quoted-printable':
$encoded = $this->EncodeQP($str);
break;
default:
$this->SetError($this->Lang('encoding') . $encoding);
break;
}
return $encoded;
} | Encodes string to requested format.
Returns an empty string on failure.
@param string $str The text to encode
@param string $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
@access public
@return string | EncodeString | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function EncodeHeader($str, $position = 'text') {
$x = 0;
switch (strtolower($position)) {
case 'phrase':
if (!preg_match('/[\200-\377]/', $str)) {
// Can't use addslashes as we don't know what value has magic_quotes_sybase
$encoded = addcslashes($str, "\0..\37\177\\\"");
if (($str == $encoded) && !preg_match('/[^A-Za-z0-9!#$%&\'*+\/=?^_`{|}~ -]/', $str)) {
return ($encoded);
} else {
return ("\"$encoded\"");
}
}
$x = preg_match_all('/[^\040\041\043-\133\135-\176]/', $str, $matches);
break;
case 'comment':
$x = preg_match_all('/[()"]/', $str, $matches);
// Fall-through
case 'text':
default:
$x += preg_match_all('/[\000-\010\013\014\016-\037\177-\377]/', $str, $matches);
break;
}
if ($x == 0) {
return ($str);
}
$maxlen = 75 - 7 - strlen($this->CharSet);
// Try to select the encoding which should produce the shortest output
if (strlen($str) / 3 < $x) {
$encoding = 'B';
if (function_exists('mb_strlen') && $this->HasMultiBytes($str)) {
// Use a custom function which correctly encodes and wraps long
// multibyte strings without breaking lines within a character
$encoded = $this->Base64EncodeWrapMB($str);
} else {
$encoded = base64_encode($str);
$maxlen -= $maxlen % 4;
$encoded = trim(chunk_split($encoded, $maxlen, "\n"));
}
} else {
$encoding = 'Q';
$encoded = $this->EncodeQ($str, $position);
$encoded = $this->WrapText($encoded, $maxlen, true);
$encoded = str_replace('=' . $this->LE, "\n", trim($encoded));
}
$encoded = preg_replace('/^(.*)$/m', " =?" . $this->CharSet . "?$encoding?\\1?=", $encoded);
$encoded = trim(str_replace("\n", $this->LE, $encoded));
return $encoded;
} | Encode a header string to best (shortest) of Q, B, quoted or none.
@access public
@return string | EncodeHeader | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function HasMultiBytes($str) {
if (function_exists('mb_strlen')) {
return (strlen($str) > mb_strlen($str, $this->CharSet));
} else {
// Assume no multibytes (we can't handle without mbstring functions anyway)
return false;
}
} | Checks if a string contains multibyte characters.
@access public
@param string $str multi-byte text to wrap encode
@return bool | HasMultiBytes | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function Base64EncodeWrapMB($str) {
$start = "=?" . $this->CharSet . "?B?";
$end = "?=";
$encoded = "";
$mb_length = mb_strlen($str, $this->CharSet);
// Each line must have length <= 75, including $start and $end
$length = 75 - strlen($start) - strlen($end);
// Average multi-byte ratio
$ratio = $mb_length / strlen($str);
// Base64 has a 4:3 ratio
$offset = $avgLength = floor($length * $ratio * .75);
for ($i = 0; $i < $mb_length; $i += $offset) {
$lookBack = 0;
do {
$offset = $avgLength - $lookBack;
$chunk = mb_substr($str, $i, $offset, $this->CharSet);
$chunk = base64_encode($chunk);
$lookBack++;
} while (strlen($chunk) > $length);
$encoded .= $chunk . $this->LE;
}
// Chomp the last linefeed
$encoded = substr($encoded, 0, -strlen($this->LE));
return $encoded;
} | Correctly encodes and wraps long multibyte strings for mail headers
without breaking lines within a character.
Adapted from a function by paravoid at http://uk.php.net/manual/en/function.mb-encode-mimeheader.php
@access public
@param string $str multi-byte text to wrap encode
@return string | Base64EncodeWrapMB | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function AddStringAttachment($string, $filename, $encoding = 'base64', $type = 'application/octet-stream') {
// Append to $attachment array
$this->attachment[] = array(
0 => $string,
1 => $filename,
2 => basename($filename),
3 => $encoding,
4 => $type,
5 => true, // isStringAttachment
6 => 'attachment',
7 => 0,
);
} | Adds a string or binary attachment (non-filesystem) to the list.
This method can be used to attach ascii or binary data,
such as a BLOB record from a database.
@param string $string String attachment data.
@param string $filename Name of the attachment.
@param string $encoding File encoding (see $Encoding).
@param string $type File extension (MIME) type.
@return void | AddStringAttachment | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function AddEmbeddedImage($path, $cid, $name = '', $encoding = 'base64', $type = 'application/octet-stream') {
if (!@is_file($path)) {
$this->SetError($this->Lang('file_access') . $path);
return false;
}
$filename = basename($path);
if ($name == '') {
$name = $filename;
}
// Append to $attachment array
$this->attachment[] = array(
0 => $path,
1 => $filename,
2 => $name,
3 => $encoding,
4 => $type,
5 => false, // isStringAttachment
6 => 'inline',
7 => $cid,
);
return true;
} | Adds an embedded attachment. This can include images, sounds, and
just about any other document. Make sure to set the $type to an
image type. For JPEG images use "image/jpeg" and for GIF images
use "image/gif".
@param string $path Path to the attachment.
@param string $cid Content ID of the attachment. Use this to identify
the Id for accessing the image in an HTML form.
@param string $name Overrides the attachment name.
@param string $encoding File encoding (see $Encoding).
@param string $type File extension (MIME) type.
@return bool | AddEmbeddedImage | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function InlineImageExists() {
foreach ($this->attachment as $attachment) {
if ($attachment[6] == 'inline') {
return true;
}
}
return false;
} | Returns true if an inline attachment is present.
@access public
@return bool | InlineImageExists | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function ClearReplyTos() {
$this->ReplyTo = array();
} | Clears all recipients assigned in the ReplyTo array. Returns void.
@return void | ClearReplyTos | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function ClearAllRecipients() {
$this->to = array();
$this->cc = array();
$this->bcc = array();
$this->all_recipients = array();
} | Clears all recipients assigned in the TO, CC and BCC
array. Returns void.
@return void | ClearAllRecipients | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function ClearAttachments() {
$this->attachment = array();
} | Clears all previously set filesystem, string, and binary
attachments. Returns void.
@return void | ClearAttachments | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function ClearCustomHeaders() {
$this->CustomHeader = array();
} | Clears all custom headers. Returns void.
@return void | ClearCustomHeaders | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
protected function SetError($msg) {
$this->error_count++;
if ($this->Mailer == 'smtp' and !is_null($this->smtp)) {
$lasterror = $this->smtp->getError();
if (!empty($lasterror) and array_key_exists('smtp_msg', $lasterror)) {
$msg .= '<p>' . $this->Lang('smtp_error') . $lasterror['smtp_msg'] . "</p>\n";
}
}
$this->ErrorInfo = $msg;
} | Adds the error message to the error container.
@access protected
@return void | SetError | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public static function RFCDate() {
$tz = date('Z');
$tzs = ($tz < 0) ? '-' : '+';
$tz = abs($tz);
$tz = (int) ($tz / 3600) * 100 + ($tz % 3600) / 60;
$result = sprintf("%s %s%04d", date('D, j M Y H:i:s'), $tzs, $tz);
return $result;
} | Returns the proper RFC 822 formatted date.
@access public
@return string
@static | RFCDate | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
private function ServerHostname() {
if (!empty($this->Hostname)) {
$result = $this->Hostname;
} elseif (isset($_SERVER['SERVER_NAME'])) {
$result = $_SERVER['SERVER_NAME'];
} else {
$result = 'localhost.localdomain';
}
return $result;
} | Returns the server hostname or 'localhost.localdomain' if unknown.
@access private
@return string | ServerHostname | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
private function Lang($key) {
if (count($this->language) < 1) {
$this->SetLanguage('en'); // set the default language
}
if (isset($this->language[$key])) {
return $this->language[$key];
} else {
return 'Language string failed to load: ' . $key;
}
} | Returns a message in the appropriate language.
@access private
@return string | Lang | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function IsError() {
return ($this->error_count > 0);
} | Returns true if an error occurred.
@access public
@return bool | IsError | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
private function FixEOL($str) {
$str = str_replace("\r\n", "\n", $str);
$str = str_replace("\r", "\n", $str);
$str = str_replace("\n", $this->LE, $str);
return $str;
} | Changes every end of line from CR or LF to CRLF.
@access private
@return string | FixEOL | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
public function MsgHTML($message, $basedir = '') {
preg_match_all("/(src|background)=\"(.*)\"/Ui", $message, $images);
if (isset($images[2])) {
foreach ($images[2] as $i => $url) {
// do not change urls for absolute images (thanks to corvuscorax)
if (!preg_match('#^[A-z]+://#', $url)) {
$filename = basename($url);
$directory = dirname($url);
($directory == '.') ? $directory = '' : '';
$cid = 'cid:' . md5($filename);
$ext = pathinfo($filename, PATHINFO_EXTENSION);
$mimeType = self::_mime_types($ext);
if (strlen($basedir) > 1 && substr($basedir, -1) != '/') {$basedir .= '/';}
if (strlen($directory) > 1 && substr($directory, -1) != '/') {$directory .= '/';}
if ($this->AddEmbeddedImage($basedir . $directory . $filename, md5($filename), $filename, 'base64', $mimeType)) {
$message = preg_replace("/" . $images[1][$i] . "=\"" . preg_quote($url, '/') . "\"/Ui", $images[1][$i] . "=\"" . $cid . "\"", $message);
}
}
}
}
$this->IsHTML(true);
$this->Body = $message;
$textMsg = trim(strip_tags(preg_replace('/<(head|title|style|script)[^>]*>.*?<\/\\1>/s', '', $message)));
if (!empty($textMsg) && empty($this->AltBody)) {
$this->AltBody = html_entity_decode($textMsg);
}
if (empty($this->AltBody)) {
$this->AltBody = 'To view this email message, open it in a program that understands HTML!' . "\n\n";
}
} | Evaluates the message and returns modifications for inline images and backgrounds
@access public
@return $message | MsgHTML | php | zblogcn/zblogphp | zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | https://github.com/zblogcn/zblogphp/blob/master/zb_users/theme/tpure/plugin/phpmailer/phpmailer.php | MIT |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.